{"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/ip-access-management-get-recent-access-attempts":{"get":{"operationId":"communication_sendgrid_ip_access_management_get_recent_access_attempts","summary":"Retrieve all recent access attempts","description":"GET /access_settings/activity","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Limits the number of IPs to return.","schema":{"type":"integer","default":20,"description":"Limits the number of IPs to return."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/ip-access-management-get-allowed-ips":{"get":{"operationId":"communication_sendgrid_ip_access_management_get_allowed_ips","summary":"Retrieve a list of currently allowed IPs","description":"GET /access_settings/whitelist","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/ip-access-management-add-allowed-ips":{"post":{"operationId":"communication_sendgrid_ip_access_management_add_allowed_ips","summary":"Add one or more IPs to the allow list","description":"POST /access_settings/whitelist","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/ip-access-management-remove-ip-addresses":{"post":{"operationId":"communication_sendgrid_ip_access_management_remove_ip_addresses","summary":"Remove one or more IPs from the allow list","description":"DELETE /access_settings/whitelist","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/ip-access-management-get-allowed-ip":{"get":{"operationId":"communication_sendgrid_ip_access_management_get_allowed_ip","summary":"Retrieve a specific allowed IP","description":"GET /access_settings/whitelist/{rule_id}","tags":["communication"],"parameters":[{"name":"rule_id","in":"query","required":true,"description":"The ID of the allowed IP address that you want to retrieve.","schema":{"type":"string","description":"The ID of the allowed IP address that you want to retrieve."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/ip-access-management-remove-specific-ip-from-allowed-list":{"post":{"operationId":"communication_sendgrid_ip_access_management_remove_specific_ip_from_allowed_list","summary":"Remove a specific IP from the allowed list","description":"DELETE /access_settings/whitelist/{rule_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["rule_id"],"properties":{"rule_id":{"type":"string","description":"The ID of the allowed IP address that you want to retrieve."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/get-alerts":{"get":{"operationId":"communication_sendgrid_get_alerts","summary":"Retrieve all alerts","description":"GET /alerts","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/post-alerts":{"post":{"operationId":"communication_sendgrid_post_alerts","summary":"Create a new Alert","description":"POST /alerts","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string"},"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/alerts-get-specific-alert":{"get":{"operationId":"communication_sendgrid_alerts_get_specific_alert","summary":"Retrieve a specific alert","description":"GET /alerts/{alert_id}","tags":["communication"],"parameters":[{"name":"alert_id","in":"query","required":true,"description":"The ID of the alert you would like to retrieve.","schema":{"type":"integer","description":"The ID of the alert you would like to retrieve."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/alerts-update-alert":{"post":{"operationId":"communication_sendgrid_alerts_update_alert","summary":"Update an alert","description":"PATCH /alerts/{alert_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["alert_id"],"properties":{"alert_id":{"type":"integer","description":"The ID of the alert you would like to retrieve."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/alerts-delete-alert-by-id":{"post":{"operationId":"communication_sendgrid_alerts_delete_alert_by_id","summary":"Delete an alert","description":"DELETE /alerts/{alert_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["alert_id"],"properties":{"alert_id":{"type":"integer","description":"The ID of the alert you would like to retrieve."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/api-keys-get-all":{"get":{"operationId":"communication_sendgrid_api_keys_get_all","summary":"Retrieve all API Keys belonging to the authenticated user","description":"GET /api_keys","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer"}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/api-keys-create-key":{"post":{"operationId":"communication_sendgrid_api_keys_create_key","summary":"Create API keys","description":"POST /api_keys","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/api-keys-get-by-key-id":{"get":{"operationId":"communication_sendgrid_api_keys_get_by_key_id","summary":"Retrieve an existing API Key","description":"GET /api_keys/{api_key_id}","tags":["communication"],"parameters":[{"name":"api_key_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/api-keys-update-name-and-scopes":{"post":{"operationId":"communication_sendgrid_api_keys_update_name_and_scopes","summary":"Update API key name and scopes","description":"PUT /api_keys/{api_key_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["api_key_id"],"properties":{"api_key_id":{"type":"string"},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/api-keys-update-key-name":{"post":{"operationId":"communication_sendgrid_api_keys_update_key_name","summary":"Update API key name","description":"PATCH /api_keys/{api_key_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["api_key_id"],"properties":{"api_key_id":{"type":"string"},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/api-keys-revoke-key":{"post":{"operationId":"communication_sendgrid_api_keys_revoke_key","summary":"Delete API keys","description":"DELETE /api_keys/{api_key_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["api_key_id"],"properties":{"api_key_id":{"type":"string"},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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-unsubscribe-groups-get-all":{"get":{"operationId":"communication_sendgrid_suppressions_unsubscribe_groups_get_all","summary":"Retrieve all suppression groups associated with the user.","description":"GET /asm/groups","tags":["communication"],"parameters":[{"name":"id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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-unsubscribe-groups-create-new-group":{"post":{"operationId":"communication_sendgrid_suppressions_unsubscribe_groups_create_new_group","summary":"Create a new suppression group","description":"POST /asm/groups","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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-unsubscribe-groups-get-single-group":{"get":{"operationId":"communication_sendgrid_suppressions_unsubscribe_groups_get_single_group","summary":"Get information on a single suppression group.","description":"GET /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,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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-unsubscribe-groups-update-group":{"post":{"operationId":"communication_sendgrid_suppressions_unsubscribe_groups_update_group","summary":"Update a suppression group.","description":"PATCH /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","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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-unsubscribe-groups-delete-group":{"post":{"operationId":"communication_sendgrid_suppressions_unsubscribe_groups_delete_group","summary":"Delete a Suppression Group","description":"DELETE /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","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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-suppressions-get-all-suppressed-emails":{"get":{"operationId":"communication_sendgrid_suppressions_suppressions_get_all_suppressed_emails","summary":"Retrieve all suppressions for a suppression group","description":"GET /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,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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-suppressions-add-to-group":{"post":{"operationId":"communication_sendgrid_suppressions_suppressions_add_to_group","summary":"Add suppressions to a suppression group","description":"POST /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","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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-suppressions-search-within-group":{"post":{"operationId":"communication_sendgrid_suppressions_suppressions_search_within_group","summary":"Search for suppressions within a group","description":"POST /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","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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-suppressions-remove-suppression-from-group":{"post":{"operationId":"communication_sendgrid_suppressions_suppressions_remove_suppression_from_group","summary":"Delete a suppression from a suppression group","description":"DELETE /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","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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-suppressions-get-all-suppressions":{"get":{"operationId":"communication_sendgrid_suppressions_suppressions_get_all_suppressions","summary":"Retrieve all suppressions","description":"GET /asm/suppressions","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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-global-suppressions-add-recipient-addresses":{"post":{"operationId":"communication_sendgrid_suppressions_global_suppressions_add_recipient_addresses","summary":"Add recipient addresses to the global suppression group.","description":"POST /asm/suppressions/global","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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-global-suppressions-get-global-suppression":{"get":{"operationId":"communication_sendgrid_suppressions_global_suppressions_get_global_suppression","summary":"Retrieve a Global Suppression","description":"GET /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,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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-global-suppressions-remove-email":{"post":{"operationId":"communication_sendgrid_suppressions_global_suppressions_remove_email","summary":"Delete a Global Suppression","description":"DELETE /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","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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-suppressions-get-unsubscribe-groups-by-email":{"get":{"operationId":"communication_sendgrid_suppressions_suppressions_get_unsubscribe_groups_by_email","summary":"Retrieve all suppression groups for an email address","description":"GET /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,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/stats-get-email-statistics-by-browser":{"get":{"operationId":"communication_sendgrid_stats_get_email_statistics_by_browser","summary":"Retrieve email statistics by browser.","description":"GET /browsers/stats","tags":["communication"],"parameters":[{"name":"browsers","in":"query","required":false,"description":"The browsers to get statistics for. You can include up to 10 different browsers by including this parameter multiple times.","schema":{"type":"string","description":"The browsers to get statistics for. You can include up to 10 different browsers by including this parameter multiple times."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}},{"name":"limit","in":"query","required":false,"description":"The number of results to return.","schema":{"type":"integer","description":"The number of results to return."}},{"name":"offset","in":"query","required":false,"description":"The point in the list to begin retrieving results.","schema":{"type":"integer","description":"The point in the list to begin retrieving results."}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}}],"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/get-campaigns":{"get":{"operationId":"communication_sendgrid_get_campaigns","summary":"Retrieve all Campaigns","description":"GET /campaigns","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"The number of results you would like to receive at a time.","schema":{"type":"integer","default":10,"description":"The number of results you would like to receive at a time."}},{"name":"offset","in":"query","required":false,"description":"The index of the first campaign to return, where 0 is the first campaign.","schema":{"type":"integer","default":0,"description":"The index of the first campaign to return, where 0 is the first campaign."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/post-campaigns":{"post":{"operationId":"communication_sendgrid_post_campaigns","summary":"Create a Campaign","description":"POST /campaigns","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/campaigns-api-get-single-campaign":{"get":{"operationId":"communication_sendgrid_campaigns_api_get_single_campaign","summary":"Retrieve a single campaign","description":"GET /campaigns/{campaign_id}","tags":["communication"],"parameters":[{"name":"campaign_id","in":"query","required":true,"description":"The id of the campaign you would like to retrieve.","schema":{"type":"integer","description":"The id of the campaign you would like to retrieve."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/campaigns-api-update-specific-campaign":{"post":{"operationId":"communication_sendgrid_campaigns_api_update_specific_campaign","summary":"Update a Campaign","description":"PATCH /campaigns/{campaign_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id"],"properties":{"campaign_id":{"type":"integer","description":"The id of the campaign you would like to retrieve."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/campaigns-api-delete-campaign-by-id":{"post":{"operationId":"communication_sendgrid_campaigns_api_delete_campaign_by_id","summary":"Delete a Campaign","description":"DELETE /campaigns/{campaign_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id"],"properties":{"campaign_id":{"type":"integer","description":"The id of the campaign you would like to retrieve."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/campaigns-api-get-scheduled-time":{"get":{"operationId":"communication_sendgrid_campaigns_api_get_scheduled_time","summary":"View Scheduled Time of a Campaign","description":"GET /campaigns/{campaign_id}/schedules","tags":["communication"],"parameters":[{"name":"campaign_id","in":"query","required":true,"schema":{"type":"integer"}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/campaigns-api-schedule-campaign":{"post":{"operationId":"communication_sendgrid_campaigns_api_schedule_campaign","summary":"Schedule a Campaign","description":"POST /campaigns/{campaign_id}/schedules","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id"],"properties":{"campaign_id":{"type":"integer"},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/campaigns-api-update-scheduled-time":{"post":{"operationId":"communication_sendgrid_campaigns_api_update_scheduled_time","summary":"Update a Scheduled Campaign","description":"PATCH /campaigns/{campaign_id}/schedules","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id"],"properties":{"campaign_id":{"type":"integer"},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/campaigns-api-unschedule-campaign":{"post":{"operationId":"communication_sendgrid_campaigns_api_unschedule_campaign","summary":"Unschedule a Scheduled Campaign","description":"DELETE /campaigns/{campaign_id}/schedules","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id"],"properties":{"campaign_id":{"type":"integer"},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/campaigns-api-send-campaign-now":{"post":{"operationId":"communication_sendgrid_campaigns_api_send_campaign_now","summary":"Send a Campaign","description":"POST /campaigns/{campaign_id}/schedules/now","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id"],"properties":{"campaign_id":{"type":"integer"},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/campaigns-api-send-test-campaign":{"post":{"operationId":"communication_sendgrid_campaigns_api_send_test_campaign","summary":"Send a Test Campaign","description":"POST /campaigns/{campaign_id}/schedules/test","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id"],"properties":{"campaign_id":{"type":"integer"},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/get-categories":{"get":{"operationId":"communication_sendgrid_get_categories","summary":"Retrieve all categories","description":"GET /categories","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"The number of categories to display per page.","schema":{"type":"integer","default":50,"description":"The number of categories to display per page."}},{"name":"category","in":"query","required":false,"description":"Allows you to perform a prefix search on this particular category.","schema":{"type":"string","description":"Allows you to perform a prefix search on this particular category."}},{"name":"offset","in":"query","required":false,"description":"The point in the list that you would like to begin displaying results.","schema":{"type":"integer","default":0,"description":"The point in the list that you would like to begin displaying results."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/categories-get-email-statistics-for":{"get":{"operationId":"communication_sendgrid_categories_get_email_statistics_for","summary":"Retrieve Email Statistics for Categories","description":"GET /categories/stats","tags":["communication"],"parameters":[{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD"}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}},{"name":"categories","in":"query","required":true,"description":"The individual categories that you want to retrieve statistics for. You may include up to 10 different categories.","schema":{"type":"string","description":"The individual categories that you want to retrieve statistics for. You may include up to 10 different categories."}},{"name":"limit","in":"query","required":false,"description":"The number of results to include.","schema":{"type":"integer","default":500,"description":"The number of results to include."}},{"name":"offset","in":"query","required":false,"description":"The number of results to skip.","schema":{"type":"integer","description":"The number of results to skip."}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/categories-get-sums":{"get":{"operationId":"communication_sendgrid_categories_get_sums","summary":"Retrieve sums of email stats for each category [Needs: Stats object defined, has category ID?]","description":"GET /categories/stats/sums","tags":["communication"],"parameters":[{"name":"sort_by_metric","in":"query","required":false,"description":"The metric that you want to sort by. Must be a single metric.","schema":{"type":"string","default":"delivered","description":"The metric that you want to sort by. Must be a single metric."}},{"name":"sort_by_direction","in":"query","required":false,"description":"The direction you want to sort.","schema":{"type":"string","enum":["desc","asc"],"default":"desc","description":"The direction you want to sort."}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}},{"name":"limit","in":"query","required":false,"description":"Limits the number of results returned.","schema":{"type":"integer","default":5,"description":"Limits the number of results returned."}},{"name":"offset","in":"query","required":false,"description":"The point in the list to begin retrieving results.","schema":{"type":"integer","default":0,"description":"The point in the list to begin retrieving results."}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/stats-get-email-statistics-by-client-type":{"get":{"operationId":"communication_sendgrid_stats_get_email_statistics_by_client_type","summary":"Retrieve email statistics by client type.","description":"GET /clients/stats","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}}],"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/stats-get-stats-by-client-type":{"get":{"operationId":"communication_sendgrid_stats_get_stats_by_client_type","summary":"Retrieve stats by a specific client type.","description":"GET /clients/{client_type}/stats","tags":["communication"],"parameters":[{"name":"client_type","in":"query","required":true,"description":"Specifies the type of client to retrieve stats for. Must be either \"phone\", \"tablet\", \"webmail\", or \"desktop\".","schema":{"type":"string","enum":["phone","tablet","webmail","desktop"],"description":"Specifies the type of client to retrieve stats for. Must be either \"phone\", \"tablet\", \"webmail\", or \"desktop\"."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}}],"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/contacts-api-custom-fields-get-all":{"get":{"operationId":"communication_sendgrid_contacts_api_custom_fields_get_all","summary":"Retrieve all custom fields","description":"GET /contactdb/custom_fields","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/contacts-api-custom-fields-create-new-field":{"post":{"operationId":"communication_sendgrid_contacts_api_custom_fields_create_new_field","summary":"Create a Custom Field","description":"POST /contactdb/custom_fields","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/contacts-api-custom-fields-get-by-id":{"get":{"operationId":"communication_sendgrid_contacts_api_custom_fields_get_by_id","summary":"Retrieve a Custom Field","description":"GET /contactdb/custom_fields/{custom_field_id}","tags":["communication"],"parameters":[{"name":"custom_field_id","in":"query","required":true,"description":"The ID of the custom field that you want to retrieve.","schema":{"type":"integer","description":"The ID of the custom field that you want to retrieve."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/contacts-api-custom-fields-delete-by-id":{"post":{"operationId":"communication_sendgrid_contacts_api_custom_fields_delete_by_id","summary":"Delete a Custom Field","description":"DELETE /contactdb/custom_fields/{custom_field_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["custom_field_id"],"properties":{"custom_field_id":{"type":"integer","description":"The ID of the custom field that you want to retrieve."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/contacts-api-lists-get-all-lists":{"get":{"operationId":"communication_sendgrid_contacts_api_lists_get_all_lists","summary":"Retrieve all lists","description":"GET /contactdb/lists","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/contacts-api-lists-create-new-list":{"post":{"operationId":"communication_sendgrid_contacts_api_lists_create_new_list","summary":"Create a List","description":"POST /contactdb/lists","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/contacts-api-lists-delete-multiple-lists":{"post":{"operationId":"communication_sendgrid_contacts_api_lists_delete_multiple_lists","summary":"Delete Multiple lists","description":"DELETE /contactdb/lists","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/contacts-api-lists-get-single-list":{"get":{"operationId":"communication_sendgrid_contacts_api_lists_get_single_list","summary":"Retrieve a single list","description":"GET /contactdb/lists/{list_id}","tags":["communication"],"parameters":[{"name":"list_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"list_id","in":"query","required":false,"description":"The ID of the list to retrieve.","schema":{"type":"integer","description":"The ID of the list to retrieve."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/contacts-api-lists-update-list-name":{"post":{"operationId":"communication_sendgrid_contacts_api_lists_update_list_name","summary":"Update a List","description":"PATCH /contactdb/lists/{list_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["list_id","list_id"],"properties":{"list_id":{"type":"integer","description":"The ID of the list you are updating."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/contacts-api-lists-delete-list-by-id":{"post":{"operationId":"communication_sendgrid_contacts_api_lists_delete_list_by_id","summary":"Delete a List","description":"DELETE /contactdb/lists/{list_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["list_id"],"properties":{"list_id":{"type":"string"},"delete_contacts":{"type":"boolean","enum":[true,false],"description":"Adds the ability to delete all contacts on the list in addition to deleting the list."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/contacts-api-lists-get-all-recipients":{"get":{"operationId":"communication_sendgrid_contacts_api_lists_get_all_recipients","summary":"Retrieve all recipients on a List","description":"GET /contactdb/lists/{list_id}/recipients","tags":["communication"],"parameters":[{"name":"list_id","in":"query","required":true,"description":"The id of the list of recipients you want to retrieve.","schema":{"type":"integer","description":"The id of the list of recipients you want to retrieve."}},{"name":"page","in":"query","required":false,"description":"Page index of first recipient to return (must be a positive integer)","schema":{"type":"integer","description":"Page index of first recipient to return (must be a positive integer)"}},{"name":"page_size","in":"query","required":false,"description":"Number of recipients to return at a time (must be a positive integer between 1 and 1000)","schema":{"type":"integer","description":"Number of recipients to return at a time (must be a positive integer between 1 and 1000)"}},{"name":"list_id","in":"query","required":true,"description":"The ID of the list whose recipients you are requesting.","schema":{"type":"integer","description":"The ID of the list whose recipients you are requesting."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/contacts-api-lists-add-multiple-recipients-to-list":{"post":{"operationId":"communication_sendgrid_contacts_api_lists_add_multiple_recipients_to_list","summary":"Add Multiple Recipients to a List","description":"POST /contactdb/lists/{list_id}/recipients","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["list_id"],"properties":{"list_id":{"type":"integer","description":"The id of the list of recipients you want to retrieve."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/contacts-api-lists-add-single-recipient":{"post":{"operationId":"communication_sendgrid_contacts_api_lists_add_single_recipient","summary":"Add a Single Recipient to a List","description":"POST /contactdb/lists/{list_id}/recipients/{recipient_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["list_id","recipient_id"],"properties":{"list_id":{"type":"integer","description":"The ID of the list that you want to add the recipient to."},"recipient_id":{"type":"string","description":"The ID of the recipient you are adding to the list."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/contacts-api-lists-delete-recipient":{"post":{"operationId":"communication_sendgrid_contacts_api_lists_delete_recipient","summary":"Delete a Single Recipient from a Single List","description":"DELETE /contactdb/lists/{list_id}/recipients/{recipient_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["list_id","recipient_id","list_id","recipient_id"],"properties":{"list_id":{"type":"integer","description":"The ID of the list you are taking this recipient away from."},"recipient_id":{"type":"integer","description":"The ID of the recipient to take off the list."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/contacts-api-recipients-get-all-recipients":{"get":{"operationId":"communication_sendgrid_contacts_api_recipients_get_all_recipients","summary":"Retrieve recipients","description":"GET /contactdb/recipients","tags":["communication"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page index of first recipients to return (must be a positive integer)","schema":{"type":"integer","description":"Page index of first recipients to return (must be a positive integer)"}},{"name":"page_size","in":"query","required":false,"description":"Number of recipients to return at a time (must be a positive integer between 1 and 1000)","schema":{"type":"integer","description":"Number of recipients to return at a time (must be a positive integer between 1 and 1000)"}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/contacts-api-recipients-add-recipient":{"post":{"operationId":"communication_sendgrid_contacts_api_recipients_add_recipient","summary":"Add recipients","description":"POST /contactdb/recipients","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/contacts-api-recipients-update-multiple-recipients":{"post":{"operationId":"communication_sendgrid_contacts_api_recipients_update_multiple_recipients","summary":"Update Recipient","description":"PATCH /contactdb/recipients","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/contacts-api-recipients-delete-multiple-recipients":{"post":{"operationId":"communication_sendgrid_contacts_api_recipients_delete_multiple_recipients","summary":"Delete Recipients","description":"DELETE /contactdb/recipients","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/contacts-api-recipients-get-billable-count":{"get":{"operationId":"communication_sendgrid_contacts_api_recipients_get_billable_count","summary":"Retrieve the count of billable recipients","description":"GET /contactdb/recipients/billable_count","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/contacts-api-recipients-get-count-of-recipients":{"get":{"operationId":"communication_sendgrid_contacts_api_recipients_get_count_of_recipients","summary":"Retrieve a Count of Recipients","description":"GET /contactdb/recipients/count","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/contacts-api-recipients-search-recipient-by-field":{"get":{"operationId":"communication_sendgrid_contacts_api_recipients_search_recipient_by_field","summary":"Search recipients","description":"GET /contactdb/recipients/search","tags":["communication"],"parameters":[{"name":"{field_name}","in":"query","required":false,"schema":{"type":"string"}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/contacts-api-recipients-search-by-segment-conditions":{"post":{"operationId":"communication_sendgrid_contacts_api_recipients_search_by_segment_conditions","summary":"Search recipients","description":"POST /contactdb/recipients/search","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/contacts-api-recipients-get-single-recipient":{"get":{"operationId":"communication_sendgrid_contacts_api_recipients_get_single_recipient","summary":"Retrieve a single recipient","description":"GET /contactdb/recipients/{recipient_id}","tags":["communication"],"parameters":[{"name":"recipient_id","in":"query","required":true,"description":"The ID of the recipient that you want to retrieve.","schema":{"type":"string","description":"The ID of the recipient that you want to retrieve."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/contacts-api-recipients-delete-recipient-by-id":{"post":{"operationId":"communication_sendgrid_contacts_api_recipients_delete_recipient_by_id","summary":"Delete a Recipient","description":"DELETE /contactdb/recipients/{recipient_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["recipient_id"],"properties":{"recipient_id":{"type":"string","description":"The ID of the recipient that you want to retrieve."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/contacts-api-recipients-get-recipient-lists":{"get":{"operationId":"communication_sendgrid_contacts_api_recipients_get_recipient_lists","summary":"Retrieve the lists that a recipient is on","description":"GET /contactdb/recipients/{recipient_id}/lists","tags":["communication"],"parameters":[{"name":"recipient_id","in":"query","required":true,"description":"The ID of the recipient for whom you are retrieving lists.","schema":{"type":"string","description":"The ID of the recipient for whom you are retrieving lists."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/contacts-api-custom-fields-get-reserved-fields":{"get":{"operationId":"communication_sendgrid_contacts_api_custom_fields_get_reserved_fields","summary":"Retrieve reserved fields","description":"GET /contactdb/reserved_fields","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/contacts-api-segments-get-all-segments":{"get":{"operationId":"communication_sendgrid_contacts_api_segments_get_all_segments","summary":"Retrieve all segments","description":"GET /contactdb/segments","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/contacts-api-segments-create-segment":{"post":{"operationId":"communication_sendgrid_contacts_api_segments_create_segment","summary":"Create a Segment","description":"POST /contactdb/segments","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/contacts-api-segments-get-segment-by-id":{"get":{"operationId":"communication_sendgrid_contacts_api_segments_get_segment_by_id","summary":"Retrieve a segment","description":"GET /contactdb/segments/{segment_id}","tags":["communication"],"parameters":[{"name":"segment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"segment_id","in":"query","required":true,"description":"The ID of the segment you want to request.","schema":{"type":"integer","description":"The ID of the segment you want to request."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/contacts-api-segments-update-segment":{"post":{"operationId":"communication_sendgrid_contacts_api_segments_update_segment","summary":"Update a segment","description":"PATCH /contactdb/segments/{segment_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["segment_id"],"properties":{"segment_id":{"type":"string","description":"The ID of the segment you are updating."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/contacts-api-segments-delete-segment":{"post":{"operationId":"communication_sendgrid_contacts_api_segments_delete_segment","summary":"Delete a segment","description":"DELETE /contactdb/segments/{segment_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["segment_id"],"properties":{"segment_id":{"type":"string"},"delete_contacts":{"type":"boolean","description":"True to delete all contacts matching the segment in addition to deleting the segment"},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/contacts-api-segments-get-segment-recipients":{"get":{"operationId":"communication_sendgrid_contacts_api_segments_get_segment_recipients","summary":"Retrieve recipients on a segment","description":"GET /contactdb/segments/{segment_id}/recipients","tags":["communication"],"parameters":[{"name":"segment_id","in":"query","required":true,"description":"The ID of the segment from which you want to retrieve recipients.","schema":{"type":"integer","description":"The ID of the segment from which you want to retrieve recipients."}},{"name":"page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer"}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/contacts-api-recipients-get-upload-status":{"get":{"operationId":"communication_sendgrid_contacts_api_recipients_get_upload_status","summary":"Get Recipient Upload Status","description":"GET /contactdb/status","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/designs-api-get-list":{"get":{"operationId":"communication_sendgrid_designs_api_get_list","summary":"List Designs","description":"GET /designs","tags":["communication"],"parameters":[{"name":"page_size","in":"query","required":false,"description":"number of results to return","schema":{"type":"integer","default":100,"description":"number of results to return"}},{"name":"page_token","in":"query","required":false,"description":"token corresponding to a specific page of results, as provided by metadata","schema":{"type":"string","description":"token corresponding to a specific page of results, as provided by metadata"}},{"name":"summary","in":"query","required":false,"description":"set to false to return all fields","schema":{"type":"boolean","default":true,"description":"set to false to return all fields"}}],"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/designs-api-create-design":{"post":{"operationId":"communication_sendgrid_designs_api_create_design","summary":"Create Design","description":"POST /designs","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/designs-api-list-pre-built-designs":{"get":{"operationId":"communication_sendgrid_designs_api_list_pre_built_designs","summary":"List SendGrid Pre-built Designs","description":"GET /designs/pre-builts","tags":["communication"],"parameters":[{"name":"page_size","in":"query","required":false,"description":"number of results to return","schema":{"type":"integer","default":100,"description":"number of results to return"}},{"name":"page_token","in":"query","required":false,"description":"token corresponding to a specific page of results, as provided by metadata","schema":{"type":"string","description":"token corresponding to a specific page of results, as provided by metadata"}},{"name":"summary","in":"query","required":false,"description":"set to false to return all fields","schema":{"type":"boolean","default":true,"description":"set to false to return all fields"}}],"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/designs-api-get-single-pre-built-design":{"get":{"operationId":"communication_sendgrid_designs_api_get_single_pre_built_design","summary":"Get SendGrid Pre-built Design","description":"GET /designs/pre-builts/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the pre-built Design you want to duplicate.","schema":{"type":"string","description":"The ID of the pre-built Design you want to duplicate."}}],"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/designs-api-duplicate-pre-built-design":{"post":{"operationId":"communication_sendgrid_designs_api_duplicate_pre_built_design","summary":"Duplicate SendGrid Pre-built Design","description":"POST /designs/pre-builts/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the pre-built Design you want to duplicate."},"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/designs-api-get-single-design":{"get":{"operationId":"communication_sendgrid_designs_api_get_single_design","summary":"Get Design","description":"GET /designs/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the Design you want to duplicate.","schema":{"type":"string","description":"The ID of the Design you want to duplicate."}}],"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/designs-api-duplicate-design":{"post":{"operationId":"communication_sendgrid_designs_api_duplicate_design","summary":"Duplicate Design","description":"POST /designs/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the Design you want to duplicate."},"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/designs-api-update-design-by-id":{"post":{"operationId":"communication_sendgrid_designs_api_update_design_by_id","summary":"Update Design","description":"PATCH /designs/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the Design you want to duplicate."},"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/designs-api-delete-design-by-id":{"post":{"operationId":"communication_sendgrid_designs_api_delete_design_by_id","summary":"Delete Design","description":"DELETE /designs/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the Design you want to duplicate."}}}}}},"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/stats-get-email-statistics-by-device-type":{"get":{"operationId":"communication_sendgrid_stats_get_email_statistics_by_device_type","summary":"Retrieve email statistics by device type.","description":"GET /devices/stats","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}},{"name":"limit","in":"query","required":false,"description":"The number of results to return.","schema":{"type":"integer","description":"The number of results to return."}},{"name":"offset","in":"query","required":false,"description":"The point in the list to begin retrieving results.","schema":{"type":"integer","description":"The point in the list to begin retrieving results."}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}}],"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/stats-get-email-statistics-by-country-and-state-province":{"get":{"operationId":"communication_sendgrid_stats_get_email_statistics_by_country_and_state_province","summary":"Retrieve email statistics by country and state/province.","description":"GET /geo/stats","tags":["communication"],"parameters":[{"name":"country","in":"query","required":false,"description":"The country you would like to see statistics for. Currently only supported for US and CA.","schema":{"type":"string","enum":["US","CA"],"description":"The country you would like to see statistics for. Currently only supported for US and CA."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}},{"name":"limit","in":"query","required":false,"description":"The number of results to return.","schema":{"type":"integer","description":"The number of results to return."}},{"name":"offset","in":"query","required":false,"description":"The point in the list to begin retrieving results.","schema":{"type":"integer","description":"The point in the list to begin retrieving results."}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}}],"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/get-ips":{"get":{"operationId":"communication_sendgrid_get_ips","summary":"Retrieve all IP addresses","description":"GET /ips","tags":["communication"],"parameters":[{"name":"ip","in":"query","required":false,"description":"The IP address to get","schema":{"type":"string","description":"The IP address to get"}},{"name":"exclude_whitelabels","in":"query","required":false,"description":"Should we exclude reverse DNS records (whitelabels)?","schema":{"type":"boolean","description":"Should we exclude reverse DNS records (whitelabels)?"}},{"name":"limit","in":"query","required":false,"description":"The number of IPs you want returned at the same time.","schema":{"type":"integer","default":10,"description":"The number of IPs you want returned at the same time."}},{"name":"offset","in":"query","required":false,"description":"The offset for the number of IPs that you are requesting.","schema":{"type":"integer","default":0,"description":"The offset for the number of IPs that you are requesting."}},{"name":"subuser","in":"query","required":false,"description":"The subuser you are requesting for.","schema":{"type":"string","description":"The subuser you are requesting for."}},{"name":"sort_by_direction","in":"query","required":false,"description":"The direction to sort the results.","schema":{"type":"string","enum":["desc","asc"],"description":"The direction to sort the results."}}],"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/post-ips":{"post":{"operationId":"communication_sendgrid_post_ips","summary":"Add IPs","description":"POST /ips","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/ip-addresses-get-assigned-ips":{"get":{"operationId":"communication_sendgrid_ip_addresses_get_assigned_ips","summary":"Retrieve all assigned IPs","description":"GET /ips/assigned","tags":["communication"],"parameters":[],"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/ip-pools-get-all":{"get":{"operationId":"communication_sendgrid_ip_pools_get_all","summary":"Retrieve all IP pools","description":"GET /ips/pools","tags":["communication"],"parameters":[],"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/ip-pools-create-pool":{"post":{"operationId":"communication_sendgrid_ip_pools_create_pool","summary":"Create an IP pool","description":"POST /ips/pools","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/ip-pools-get-pool-ips":{"get":{"operationId":"communication_sendgrid_ip_pools_get_pool_ips","summary":"Retrieve all the IPs in a specified pool","description":"GET /ips/pools/{pool_name}","tags":["communication"],"parameters":[{"name":"pool_name","in":"query","required":true,"description":"The name of the IP pool that you want to retrieve the IP addresses for.","schema":{"type":"string","description":"The name of the IP pool that you want to retrieve the IP addresses for."}}],"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/ip-pools-update-name":{"post":{"operationId":"communication_sendgrid_ip_pools_update_name","summary":"Rename an IP pool","description":"PUT /ips/pools/{pool_name}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["pool_name"],"properties":{"pool_name":{"type":"string","description":"The name of the IP pool that you want to retrieve the IP addresses for."},"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/ip-pools-delete-pool":{"post":{"operationId":"communication_sendgrid_ip_pools_delete_pool","summary":"Delete an IP pool","description":"DELETE /ips/pools/{pool_name}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["pool_name"],"properties":{"pool_name":{"type":"string","description":"The name of the IP pool that you want to retrieve the IP addresses for."}}}}}},"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/ip-pools-add-ip-address-to-pool":{"post":{"operationId":"communication_sendgrid_ip_pools_add_ip_address_to_pool","summary":"Add an IP address to a pool","description":"POST /ips/pools/{pool_name}/ips","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["pool_name"],"properties":{"pool_name":{"type":"string","description":"The name of the IP pool you want to add the address to. If the name contains spaces, they must be URL encoded (e.g., \"Test Pool\" becomes…"},"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/ip-pools-remove-ip-address-from-pool":{"post":{"operationId":"communication_sendgrid_ip_pools_remove_ip_address_from_pool","summary":"Remove an IP address from a pool","description":"DELETE /ips/pools/{pool_name}/ips/{ip}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["pool_name","ip"],"properties":{"pool_name":{"type":"string","description":"The name of the IP pool that you are removing the IP address from."},"ip":{"type":"string","description":"The IP address that you wish to remove."}}}}}},"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/ip-addresses-get-remaining-ips-count":{"get":{"operationId":"communication_sendgrid_ip_addresses_get_remaining_ips_count","summary":"Get remaining IPs count","description":"GET /ips/remaining","tags":["communication"],"parameters":[],"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/ip-warmup-get-all-ips-warmup":{"get":{"operationId":"communication_sendgrid_ip_warmup_get_all_ips_warmup","summary":"Retrieve all IPs currently in warmup","description":"GET /ips/warmup","tags":["communication"],"parameters":[],"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/ip-warmup-start-ip-address-warmup":{"post":{"operationId":"communication_sendgrid_ip_warmup_start_ip_address_warmup","summary":"Start warming up an IP address","description":"POST /ips/warmup","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/ip-warmup-get-warmup-status-for-ip-address":{"get":{"operationId":"communication_sendgrid_ip_warmup_get_warmup_status_for_ip_address","summary":"Retrieve the warmup status for a specific IP address","description":"GET /ips/warmup/{ip_address}","tags":["communication"],"parameters":[{"name":"ip_address","in":"query","required":true,"description":"The IP address that you want to retrieve the warmup status for.","schema":{"type":"string","description":"The IP address that you want to retrieve the warmup status for."}}],"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/ip-warmup-stop-ip-address-warmup":{"post":{"operationId":"communication_sendgrid_ip_warmup_stop_ip_address_warmup","summary":"Stop warming up an IP address","description":"DELETE /ips/warmup/{ip_address}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ip_address"],"properties":{"ip_address":{"type":"string","description":"The IP address that you want to retrieve the warmup status for."}}}}}},"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/ip-addresses-get-ip-pools-by-address":{"get":{"operationId":"communication_sendgrid_ip_addresses_get_ip_pools_by_address","summary":"Retrieve all IP pools an IP address belongs to","description":"GET /ips/{ip_address}","tags":["communication"],"parameters":[{"name":"ip_address","in":"query","required":true,"description":"The IP address you are retrieving the IP pools for.","schema":{"type":"string","description":"The IP address you are retrieving the IP pools for."}}],"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/cancel-scheduled-sends-request":{"post":{"operationId":"communication_sendgrid_cancel_scheduled_sends_request","summary":"Create a batch ID","description":"POST /mail/batch","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/cancel-scheduled-sends-validate-batch-id":{"get":{"operationId":"communication_sendgrid_cancel_scheduled_sends_validate_batch_id","summary":"Validate batch ID","description":"GET /mail/batch/{batch_id}","tags":["communication"],"parameters":[{"name":"batch_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/mail-send-v3-email-send":{"post":{"operationId":"communication_sendgrid_mail_send_v3_email_send","summary":"v3 Mail Send","description":"POST /mail/send","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/settings-mail-get-all-mail-settings":{"get":{"operationId":"communication_sendgrid_settings_mail_get_all_mail_settings","summary":"Retrieve all mail settings","description":"GET /mail_settings","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"The number of settings to return.","schema":{"type":"integer","description":"The number of settings to return."}},{"name":"offset","in":"query","required":false,"description":"Where in the list of results to begin displaying settings.","schema":{"type":"integer","description":"Where in the list of results to begin displaying settings."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/settings-mail-get-address-whitelist-mail-settings":{"get":{"operationId":"communication_sendgrid_settings_mail_get_address_whitelist_mail_settings","summary":"Retrieve address whitelist mail settings","description":"GET /mail_settings/address_whitelist","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/settings-mail-update-address-whitelist-mail-settings":{"post":{"operationId":"communication_sendgrid_settings_mail_update_address_whitelist_mail_settings","summary":"Update address whitelist mail settings","description":"PATCH /mail_settings/address_whitelist","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/settings-mail-get-bounce-purge-settings":{"get":{"operationId":"communication_sendgrid_settings_mail_get_bounce_purge_settings","summary":"Retrieve bounce purge mail settings","description":"GET /mail_settings/bounce_purge","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/settings-mail-update-bounce-purge-settings":{"post":{"operationId":"communication_sendgrid_settings_mail_update_bounce_purge_settings","summary":"Update bounce purge mail settings","description":"PATCH /mail_settings/bounce_purge","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/settings-mail-get-footer-mail-settings":{"get":{"operationId":"communication_sendgrid_settings_mail_get_footer_mail_settings","summary":"Retrieve footer mail settings","description":"GET /mail_settings/footer","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/settings-mail-update-footer-mail-settings":{"post":{"operationId":"communication_sendgrid_settings_mail_update_footer_mail_settings","summary":"Update footer mail settings","description":"PATCH /mail_settings/footer","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/settings-mail-get-forward-bounce-mail-settings":{"get":{"operationId":"communication_sendgrid_settings_mail_get_forward_bounce_mail_settings","summary":"Retrieve forward bounce mail settings","description":"GET /mail_settings/forward_bounce","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/settings-mail-update-forward-bounce-settings":{"post":{"operationId":"communication_sendgrid_settings_mail_update_forward_bounce_settings","summary":"Update forward bounce mail settings","description":"PATCH /mail_settings/forward_bounce","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/settings-mail-get-forward-spam-mail-settings":{"get":{"operationId":"communication_sendgrid_settings_mail_get_forward_spam_mail_settings","summary":"Retrieve forward spam mail settings","description":"GET /mail_settings/forward_spam","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/settings-mail-update-forward-spam-settings":{"post":{"operationId":"communication_sendgrid_settings_mail_update_forward_spam_settings","summary":"Update forward spam mail settings","description":"PATCH /mail_settings/forward_spam","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/settings-mail-get-legacy-template-settings":{"get":{"operationId":"communication_sendgrid_settings_mail_get_legacy_template_settings","summary":"Retrieve legacy template mail settings","description":"GET /mail_settings/template","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/settings-mail-update-legacy-template-settings":{"post":{"operationId":"communication_sendgrid_settings_mail_update_legacy_template_settings","summary":"Update template mail settings","description":"PATCH /mail_settings/template","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/stats-get-email-statistics-by-mailbox-provider":{"get":{"operationId":"communication_sendgrid_stats_get_email_statistics_by_mailbox_provider","summary":"Retrieve email statistics by mailbox provider.","description":"GET /mailbox_providers/stats","tags":["communication"],"parameters":[{"name":"mailbox_providers","in":"query","required":false,"description":"The mail box providers to get statistics for. You can include up to 10 by including this parameter multiple times.","schema":{"type":"string","description":"The mail box providers to get statistics for. You can include up to 10 by including this parameter multiple times."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}},{"name":"limit","in":"query","required":false,"description":"The number of results to return.","schema":{"type":"integer","description":"The number of results to return."}},{"name":"offset","in":"query","required":false,"description":"The point in the list to begin retrieving results.","schema":{"type":"integer","description":"The point in the list to begin retrieving results."}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}}],"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/contacts-get-recent-contacts":{"get":{"operationId":"communication_sendgrid_contacts_get_recent_contacts","summary":"Get Sample Contacts","description":"GET /marketing/contacts","tags":["communication"],"parameters":[],"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/contacts-upsert-batch-contacts":{"post":{"operationId":"communication_sendgrid_contacts_upsert_batch_contacts","summary":"Add or Update a Contact","description":"PUT /marketing/contacts","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/contacts-delete-bulk-contacts":{"post":{"operationId":"communication_sendgrid_contacts_delete_bulk_contacts","summary":"Delete Contacts","description":"DELETE /marketing/contacts","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"delete_all_contacts":{"type":"string","description":"Must be set to `\"true\"` to delete all contacts."},"ids":{"type":"string","description":"A comma-separated list of contact IDs."}}}}}},"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/contacts-get-batched-by-ids":{"post":{"operationId":"communication_sendgrid_contacts_get_batched_by_ids","summary":"Get Batched Contacts by IDs","description":"POST /marketing/contacts/batch","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/contacts-get-total-count":{"get":{"operationId":"communication_sendgrid_contacts_get_total_count","summary":"Get Total Contact Count","description":"GET /marketing/contacts/count","tags":["communication"],"parameters":[],"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/contacts-get-all-exports":{"get":{"operationId":"communication_sendgrid_contacts_get_all_exports","summary":"Get All Existing Exports","description":"GET /marketing/contacts/exports","tags":["communication"],"parameters":[],"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/contacts-export-lists-segments":{"post":{"operationId":"communication_sendgrid_contacts_export_lists_segments","summary":"Export Contacts","description":"POST /marketing/contacts/exports","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/contacts-check-export-status":{"get":{"operationId":"communication_sendgrid_contacts_check_export_status","summary":"Export Contacts Status","description":"GET /marketing/contacts/exports/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"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/contacts-import-csv":{"post":{"operationId":"communication_sendgrid_contacts_import_csv","summary":"Import Contacts","description":"PUT /marketing/contacts/imports","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/contacts-check-import-status":{"get":{"operationId":"communication_sendgrid_contacts_check_import_status","summary":"Import Contacts Status","description":"GET /marketing/contacts/imports/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"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/contacts-search-contacts-by-query":{"post":{"operationId":"communication_sendgrid_contacts_search_contacts_by_query","summary":"Search Contacts","description":"POST /marketing/contacts/search","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/contacts-search-by-emails":{"post":{"operationId":"communication_sendgrid_contacts_search_by_emails","summary":"Get Contacts by Emails","description":"POST /marketing/contacts/search/emails","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/contacts-get-by-id-details":{"get":{"operationId":"communication_sendgrid_contacts_get_by_id_details","summary":"Get a Contact by ID","description":"GET /marketing/contacts/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"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/custom-fields-get-all-field-definitions":{"get":{"operationId":"communication_sendgrid_custom_fields_get_all_field_definitions","summary":"Get All Field Definitions","description":"GET /marketing/field_definitions","tags":["communication"],"parameters":[],"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/custom-fields-create-definition":{"post":{"operationId":"communication_sendgrid_custom_fields_create_definition","summary":"Create Custom Field Definition","description":"POST /marketing/field_definitions","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/custom-fields-update-definition":{"post":{"operationId":"communication_sendgrid_custom_fields_update_definition","summary":"Update Custom Field Definition","description":"PATCH /marketing/field_definitions/{custom_field_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["custom_field_id"],"properties":{"custom_field_id":{"type":"string"},"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/custom-fields-delete-definition":{"post":{"operationId":"communication_sendgrid_custom_fields_delete_definition","summary":"Delete Custom Field Definition","description":"DELETE /marketing/field_definitions/{custom_field_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["custom_field_id"],"properties":{"custom_field_id":{"type":"string"}}}}}},"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/lists-get-all":{"get":{"operationId":"communication_sendgrid_lists_get_all","summary":"Get All Lists","description":"GET /marketing/lists","tags":["communication"],"parameters":[{"name":"page_size","in":"query","required":false,"description":"Maximum number of elements to return. Defaults to 100, returns 1000 max","schema":{"type":"number","default":100,"description":"Maximum number of elements to return. Defaults to 100, returns 1000 max"}},{"name":"page_token","in":"query","required":false,"schema":{"type":"string"}}],"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/lists-create-new-list":{"post":{"operationId":"communication_sendgrid_lists_create_new_list","summary":"Create List","description":"POST /marketing/lists","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/lists-get-list-by-id":{"get":{"operationId":"communication_sendgrid_lists_get_list_by_id","summary":"Get a List by ID","description":"GET /marketing/lists/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}},{"name":"contact_sample","in":"query","required":false,"description":"Setting this parameter to the true will cause the contact_sample to be returned","schema":{"type":"boolean","default":false,"description":"Setting this parameter to the true will cause the contact_sample to be returned"}}],"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/lists-update-name":{"post":{"operationId":"communication_sendgrid_lists_update_name","summary":"Update List","description":"PATCH /marketing/lists/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"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/lists-delete-list":{"post":{"operationId":"communication_sendgrid_lists_delete_list","summary":"Delete a list","description":"DELETE /marketing/lists/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"delete_contacts":{"type":"boolean","default":false,"description":"Flag indicates that all contacts on the list are also to be deleted."}}}}}},"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/lists-remove-contacts-from-list":{"post":{"operationId":"communication_sendgrid_lists_remove_contacts_from_list","summary":"Remove Contacts from a List","description":"DELETE /marketing/lists/{id}/contacts","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","contact_ids"],"properties":{"id":{"type":"string"},"contact_ids":{"type":"string","description":"comma separated list of contact ids"}}}}}},"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/lists-contact-count-get":{"get":{"operationId":"communication_sendgrid_lists_contact_count_get","summary":"Get List Contact Count","description":"GET /marketing/lists/{id}/contacts/count","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"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/segmenting-contacts-list-segments":{"get":{"operationId":"communication_sendgrid_segmenting_contacts_list_segments","summary":"Get List of Segments","description":"GET /marketing/segments","tags":["communication"],"parameters":[{"name":"parent_list_ids","in":"query","required":false,"description":"A comma separated list of list ids to be used when searching for segments with the specified parent_list_id, no more than 50 is allowed","schema":{"type":"string","description":"A comma separated list of list ids to be used when searching for segments with the specified parent_list_id, no more than 50 is allowed"}},{"name":"no_parent_list_id","in":"query","required":false,"description":"If set to `true` segments with an empty value of `parent_list_id` will be returned in the filter. If the value is not present it defaults…","schema":{"type":"boolean","default":false,"description":"If set to `true` segments with an empty value of `parent_list_id` will be returned in the filter. If the value is not present it defaults…"}}],"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/segmenting-contacts-create-new-segment":{"post":{"operationId":"communication_sendgrid_segmenting_contacts_create_new_segment","summary":"Create Segment","description":"POST /marketing/segments","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/get-segments":{"get":{"operationId":"communication_sendgrid_get_segments","summary":"Get List of Segments","description":"GET /marketing/segments/2.0","tags":["communication"],"parameters":[{"name":"parent_list_ids","in":"query","required":false,"description":"A comma separated list up to 50 in size, to filter segments on. Only segments that have any of these list ids as the parent list will be…","schema":{"type":"string","description":"A comma separated list up to 50 in size, to filter segments on. Only segments that have any of these list ids as the parent list will be…"}},{"name":"no_parent_list_id","in":"query","required":false,"description":"If set to `true` segments with an empty value of `parent_list_id` will be returned in the filter. If the value is not present it defaults…","schema":{"type":"boolean","default":false,"description":"If set to `true` segments with an empty value of `parent_list_id` will be returned in the filter. If the value is not present it defaults…"}}],"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/post-segments":{"post":{"operationId":"communication_sendgrid_post_segments","summary":"Create Segment","description":"POST /marketing/segments/2.0","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/segmenting-contacts-v2-beta-get-by-id":{"get":{"operationId":"communication_sendgrid_segmenting_contacts_v2_beta_get_by_id","summary":"Get Segment by ID","description":"GET /marketing/segments/2.0/{segment_id}","tags":["communication"],"parameters":[{"name":"segment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"contacts_sample","in":"query","required":false,"description":"Defaults to `true`. Set to `false` to exclude the contacts_sample in the response.","schema":{"type":"boolean","description":"Defaults to `true`. Set to `false` to exclude the contacts_sample in the response."}}],"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/segmenting-contacts-v2-beta-update-segment-by-id":{"post":{"operationId":"communication_sendgrid_segmenting_contacts_v2_beta_update_segment_by_id","summary":"Update Segment","description":"PATCH /marketing/segments/2.0/{segment_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["segment_id"],"properties":{"segment_id":{"type":"string"},"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/segmenting-contacts-v2-beta-delete-segment-by-id":{"post":{"operationId":"communication_sendgrid_segmenting_contacts_v2_beta_delete_segment_by_id","summary":"Delete segment","description":"DELETE /marketing/segments/2.0/{segment_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["segment_id"],"properties":{"segment_id":{"type":"string"}}}}}},"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/segmenting-contacts-bulk-delete-segments":{"post":{"operationId":"communication_sendgrid_segmenting_contacts_bulk_delete_segments","summary":"Bulk Delete Segments","description":"POST /marketing/segments/delete","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/segmenting-contacts-get-by-id":{"get":{"operationId":"communication_sendgrid_segmenting_contacts_get_by_id","summary":"Get Segment by ID","description":"GET /marketing/segments/{segment_id}","tags":["communication"],"parameters":[{"name":"segment_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"query_json","in":"query","required":false,"description":"Defaults to `false`. Set to `true` to return the parsed SQL AST as a JSON object in the field `query_json`","schema":{"type":"boolean","description":"Defaults to `false`. Set to `true` to return the parsed SQL AST as a JSON object in the field `query_json`"}}],"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/segmenting-contacts-update-segment-by-id":{"post":{"operationId":"communication_sendgrid_segmenting_contacts_update_segment_by_id","summary":"Update Segment","description":"PATCH /marketing/segments/{segment_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["segment_id"],"properties":{"segment_id":{"type":"string"},"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/segmenting-contacts-delete-by-id":{"post":{"operationId":"communication_sendgrid_segmenting_contacts_delete_by_id","summary":"Delete Segment","description":"DELETE /marketing/segments/{segment_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["segment_id"],"properties":{"segment_id":{"type":"string"}}}}}},"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/senders-create-identity":{"post":{"operationId":"communication_sendgrid_senders_create_identity","summary":"Create a Sender Identity","description":"POST /marketing/senders","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/single-sends-get-all-singlesends":{"get":{"operationId":"communication_sendgrid_single_sends_get_all_singlesends","summary":"Get All Single Sends","description":"GET /marketing/singlesends","tags":["communication"],"parameters":[{"name":"page_size","in":"query","required":false,"schema":{"type":"integer"}},{"name":"page_token","in":"query","required":false,"schema":{"type":"string"}}],"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/single-sends-create-new-single-send":{"post":{"operationId":"communication_sendgrid_single_sends_create_new_single_send","summary":"Create Single Send","description":"POST /marketing/singlesends","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/single-sends-bulk-delete":{"post":{"operationId":"communication_sendgrid_single_sends_bulk_delete","summary":"Bulk Delete Single Sends","description":"DELETE /marketing/singlesends","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ids":{"type":"array","description":"Single Send IDs to delete"}}}}}},"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/single-sends-get-all-categories":{"get":{"operationId":"communication_sendgrid_single_sends_get_all_categories","summary":"Get All Categories","description":"GET /marketing/singlesends/categories","tags":["communication"],"parameters":[],"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/single-sends-search-by-criteria":{"post":{"operationId":"communication_sendgrid_single_sends_search_by_criteria","summary":"Get Single Sends Search","description":"POST /marketing/singlesends/search","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"page_size":{"type":"integer"},"page_token":{"type":"string"},"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/single-sends-get-details-by-id":{"get":{"operationId":"communication_sendgrid_single_sends_get_details_by_id","summary":"Get Single Send by ID","description":"GET /marketing/singlesends/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"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/single-sends-duplicate-single-send":{"post":{"operationId":"communication_sendgrid_single_sends_duplicate_single_send","summary":"Duplicate Single Send","description":"POST /marketing/singlesends/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"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/single-sends-update-by-id":{"post":{"operationId":"communication_sendgrid_single_sends_update_by_id","summary":"Update Single Send","description":"PATCH /marketing/singlesends/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"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/single-sends-delete-by-id":{"post":{"operationId":"communication_sendgrid_single_sends_delete_by_id","summary":"Delete Single Send by ID","description":"DELETE /marketing/singlesends/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"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/single-sends-schedule-put":{"post":{"operationId":"communication_sendgrid_single_sends_schedule_put","summary":"Schedule Single Send","description":"PUT /marketing/singlesends/{id}/schedule","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"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/single-sends-cancel-scheduled-send":{"post":{"operationId":"communication_sendgrid_single_sends_cancel_scheduled_send","summary":"Delete Single Send Schedule","description":"DELETE /marketing/singlesends/{id}/schedule","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"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/marketing-campaigns-stats-get-all-automation-stats":{"get":{"operationId":"communication_sendgrid_marketing_campaigns_stats_get_all_automation_stats","summary":"Get All Automation Stats","description":"GET /marketing/stats/automations","tags":["communication"],"parameters":[{"name":"automation_ids","in":"query","required":false,"description":"This endpoint returns all automation IDs if no `automation_ids` are specified.","schema":{"type":"array","description":"This endpoint returns all automation IDs if no `automation_ids` are specified."}},{"name":"page_size","in":"query","required":false,"description":"The number of elements you want returned on each page.","schema":{"type":"integer","default":50,"description":"The number of elements you want returned on each page."}},{"name":"page_token","in":"query","required":false,"description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…","schema":{"type":"string","description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…"}}],"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/marketing-campaigns-stats-export-automation-stats":{"get":{"operationId":"communication_sendgrid_marketing_campaigns_stats_export_automation_stats","summary":"Export Automation Stats","description":"GET /marketing/stats/automations/export","tags":["communication"],"parameters":[{"name":"ids","in":"query","required":false,"description":"The IDs of Automations for which to export stats.","schema":{"type":"array","description":"The IDs of Automations for which to export stats."}},{"name":"timezone","in":"query","required":false,"description":"The [IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_time_zones) string representing the timezone in which the stats…","schema":{"type":"string","default":"UTC","description":"The [IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_time_zones) string representing the timezone in which the stats…"}}],"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/marketing-campaigns-stats-get-stats-by-id":{"get":{"operationId":"communication_sendgrid_marketing_campaigns_stats_get_stats_by_id","summary":"Get Automation Stats by ID","description":"GET /marketing/stats/automations/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}},{"name":"group_by","in":"query","required":false,"description":"Automations can have multiple steps. Including `step_id` as a `group_by` metric allows further granularity of stats.","schema":{"type":"array","description":"Automations can have multiple steps. Including `step_id` as a `group_by` metric allows further granularity of stats."}},{"name":"step_ids","in":"query","required":false,"description":"Comma-separated list of `step_ids` that you want the link stats for.","schema":{"type":"array","description":"Comma-separated list of `step_ids` that you want the link stats for."}},{"name":"aggregated_by","in":"query","required":false,"description":"Dictates how the stats are time-sliced. Currently, `\"total\"` and `\"day\"` are supported.","schema":{"type":"string","enum":["day","total"],"default":"total","description":"Dictates how the stats are time-sliced. Currently, `\"total\"` and `\"day\"` are supported."}},{"name":"start_date","in":"query","required":false,"description":"Format: `YYYY-MM-DD`. If this parameter is included, the stats' start date is included in the search.","schema":{"type":"string","default":"","description":"Format: `YYYY-MM-DD`. If this parameter is included, the stats' start date is included in the search."}},{"name":"end_date","in":"query","required":false,"description":"Format: `YYYY-MM-DD`.If this parameter is included, the stats' end date is included in the search.","schema":{"type":"string","default":"","description":"Format: `YYYY-MM-DD`.If this parameter is included, the stats' end date is included in the search."}},{"name":"timezone","in":"query","required":false,"description":"[IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_time_zones) string representing the timezone in which the stats are…","schema":{"type":"string","default":"UTC","description":"[IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_time_zones) string representing the timezone in which the stats are…"}},{"name":"page_size","in":"query","required":false,"description":"The number of elements you want returned on each page.","schema":{"type":"integer","default":50,"description":"The number of elements you want returned on each page."}},{"name":"page_token","in":"query","required":false,"description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…","schema":{"type":"string","description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…"}}],"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/marketing-campaigns-stats-get-automation-link-stat":{"get":{"operationId":"communication_sendgrid_marketing_campaigns_stats_get_automation_link_stat","summary":"Get Automation Click Tracking Stats by ID","description":"GET /marketing/stats/automations/{id}/links","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the Automation you want to get click tracking stats for.","schema":{"type":"string","description":"The ID of the Automation you want to get click tracking stats for."}},{"name":"group_by","in":"query","required":false,"description":"Automations can have multiple steps. Including `step_id` as a `group_by` metric allows further granularity of stats.","schema":{"type":"array","description":"Automations can have multiple steps. Including `step_id` as a `group_by` metric allows further granularity of stats."}},{"name":"step_ids","in":"query","required":false,"description":"Comma-separated list of `step_ids` that you want the link stats for.","schema":{"type":"array","description":"Comma-separated list of `step_ids` that you want the link stats for."}},{"name":"page_size","in":"query","required":false,"description":"The number of elements you want returned on each page.","schema":{"type":"integer","default":50,"description":"The number of elements you want returned on each page."}},{"name":"page_token","in":"query","required":false,"description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…","schema":{"type":"string","description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…"}}],"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/marketing-campaigns-stats-get-all-single-sends-stats":{"get":{"operationId":"communication_sendgrid_marketing_campaigns_stats_get_all_single_sends_stats","summary":"Get All Single Sends Stats","description":"GET /marketing/stats/singlesends","tags":["communication"],"parameters":[{"name":"singlesend_ids","in":"query","required":false,"description":"This endpoint returns all Single Send IDs if no IDs are included in `singlesend_ids`.","schema":{"type":"array","description":"This endpoint returns all Single Send IDs if no IDs are included in `singlesend_ids`."}},{"name":"page_size","in":"query","required":false,"description":"The number of elements you want returned on each page.","schema":{"type":"integer","default":50,"description":"The number of elements you want returned on each page."}},{"name":"page_token","in":"query","required":false,"description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…","schema":{"type":"string","description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…"}}],"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/marketing-campaigns-stats-export-single-send-stats":{"get":{"operationId":"communication_sendgrid_marketing_campaigns_stats_export_single_send_stats","summary":"Export Single Send Stats","description":"GET /marketing/stats/singlesends/export","tags":["communication"],"parameters":[{"name":"ids","in":"query","required":false,"description":"The IDs of Single Sends for which to export stats.","schema":{"type":"array","description":"The IDs of Single Sends for which to export stats."}},{"name":"timezone","in":"query","required":false,"description":"The [IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_time_zones) string representing the timezone in which the stats…","schema":{"type":"string","default":"UTC","description":"The [IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_time_zones) string representing the timezone in which the stats…"}}],"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/marketing-campaigns-stats-get-single-send-stats-by-id":{"get":{"operationId":"communication_sendgrid_marketing_campaigns_stats_get_single_send_stats_by_id","summary":"Get Single Send Stats by ID","description":"GET /marketing/stats/singlesends/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}},{"name":"aggregated_by","in":"query","required":false,"description":"Dictates how the stats are time-sliced. Currently, `\"total\"` and `\"day\"` are supported.","schema":{"type":"string","enum":["day","total"],"default":"total","description":"Dictates how the stats are time-sliced. Currently, `\"total\"` and `\"day\"` are supported."}},{"name":"start_date","in":"query","required":false,"description":"Format: `YYYY-MM-DD`. If this parameter is included, the stats' start date is included in the search.","schema":{"type":"string","default":"","description":"Format: `YYYY-MM-DD`. If this parameter is included, the stats' start date is included in the search."}},{"name":"end_date","in":"query","required":false,"description":"Format: `YYYY-MM-DD`.If this parameter is included, the stats' end date is included in the search.","schema":{"type":"string","default":"","description":"Format: `YYYY-MM-DD`.If this parameter is included, the stats' end date is included in the search."}},{"name":"timezone","in":"query","required":false,"description":"[IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_time_zones) string representing the timezone in which the stats are…","schema":{"type":"string","default":"UTC","description":"[IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_time_zones) string representing the timezone in which the stats are…"}},{"name":"page_size","in":"query","required":false,"description":"The number of elements you want returned on each page.","schema":{"type":"integer","default":50,"description":"The number of elements you want returned on each page."}},{"name":"page_token","in":"query","required":false,"description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…","schema":{"type":"string","description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…"}},{"name":"group_by","in":"query","required":false,"description":"A/B Single Sends have multiple variation IDs and phase IDs. Including these additional fields allows further granularity of stats by these…","schema":{"type":"array","description":"A/B Single Sends have multiple variation IDs and phase IDs. Including these additional fields allows further granularity of stats by these…"}}],"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/marketing-campaigns-stats-get-single-send-link-stat-by-id":{"get":{"operationId":"communication_sendgrid_marketing_campaigns_stats_get_single_send_link_stat_by_id","summary":"Get Single Send Click Tracking Stats by ID","description":"GET /marketing/stats/singlesends/{id}/links","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}},{"name":"page_size","in":"query","required":false,"description":"The number of elements you want returned on each page.","schema":{"type":"integer","default":50,"description":"The number of elements you want returned on each page."}},{"name":"page_token","in":"query","required":false,"description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…","schema":{"type":"string","description":"The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're…"}},{"name":"group_by","in":"query","required":false,"description":"A/B Single Sends have multiple variation IDs and phase IDs. Including these additional fields allows further granularity of stats by these…","schema":{"type":"array","description":"A/B Single Sends have multiple variation IDs and phase IDs. Including these additional fields allows further granularity of stats by these…"}},{"name":"ab_variation_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"ab_phase_id","in":"query","required":false,"schema":{"type":"string","enum":["test","send"]}}],"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/send-test-email-to-contacts":{"post":{"operationId":"communication_sendgrid_send_test_email_to_contacts","summary":"Send a Test Marketing Email","description":"POST /marketing/test/send_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/query-filter-messages":{"get":{"operationId":"communication_sendgrid_query_filter_messages","summary":"Filter all messages","description":"GET /messages","tags":["communication"],"parameters":[{"name":"query","in":"query","required":true,"description":"Use the query syntax to filter your email activity.","schema":{"type":"string","description":"Use the query syntax to filter your email activity."}},{"name":"limit","in":"query","required":false,"description":"The number of messages returned. This parameter must be greater than 0 and less than or equal to 1000","schema":{"type":"number","default":10,"description":"The number of messages returned. This parameter must be greater than 0 and less than or equal to 1000"}},{"name":"X-Query-Id","in":"query","required":false,"schema":{"type":"string"}},{"name":"X-Cursor","in":"query","required":false,"schema":{"type":"string"}}],"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/csv-ui-only-request-csv-download":{"post":{"operationId":"communication_sendgrid_csv_ui_only_request_csv_download","summary":"Request CSV","description":"POST /messages/download","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","description":"Uses a SQL like syntax to indicate which messages to include in the CSV"}}}}}},"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/csv-ui-only-generate-csv-download-url":{"get":{"operationId":"communication_sendgrid_csv_ui_only_generate_csv_download_url","summary":"Download CSV","description":"GET /messages/download/{download_uuid}","tags":["communication"],"parameters":[{"name":"download_uuid","in":"query","required":true,"description":"UUID used to locate the download csv request entry in the DB. This is the UUID provided in the email sent to the user when their csv file…","schema":{"type":"string","description":"UUID used to locate the download csv request entry in the DB. This is the UUID provided in the email sent to the user when their csv file…"}}],"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/query-message-details":{"get":{"operationId":"communication_sendgrid_query_message_details","summary":"Filter messages by message ID","description":"GET /messages/{msg_id}","tags":["communication"],"parameters":[{"name":"msg_id","in":"query","required":true,"description":"The ID of the message you are requesting details for.","schema":{"type":"string","description":"The ID of the message you are requesting details for."}}],"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/settings-partner-list-partner-settings":{"get":{"operationId":"communication_sendgrid_settings_partner_list_partner_settings","summary":"Returns a list of all partner settings.","description":"GET /partner_settings","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"The number of settings to return per page.","schema":{"type":"integer","description":"The number of settings to return per page."}},{"name":"offset","in":"query","required":false,"description":"The paging offset.","schema":{"type":"integer","description":"The paging offset."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/settings-partner-get-all-new-relic-partner-settings":{"get":{"operationId":"communication_sendgrid_settings_partner_get_all_new_relic_partner_settings","summary":"Returns all New Relic partner settings.","description":"GET /partner_settings/new_relic","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/settings-partner-update-new-relic-partner-settings":{"post":{"operationId":"communication_sendgrid_settings_partner_update_new_relic_partner_settings","summary":"Updates New Relic partner settings.","description":"PATCH /partner_settings/new_relic","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/get-scopes":{"get":{"operationId":"communication_sendgrid_get_scopes","summary":"Retrieve a list of scopes for which this user has access.","description":"GET /scopes","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/teammates-get-access-requests":{"get":{"operationId":"communication_sendgrid_teammates_get_access_requests","summary":"Retrieve access requests","description":"GET /scopes/requests","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Optional field to limit the number of results returned.","schema":{"type":"integer","default":50,"description":"Optional field to limit the number of results returned."}},{"name":"offset","in":"query","required":false,"description":"Optional beginning point in the list to retrieve from.","schema":{"type":"integer","default":0,"description":"Optional beginning point in the list to retrieve from."}}],"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/teammates-deny-access-request":{"post":{"operationId":"communication_sendgrid_teammates_deny_access_request","summary":"Deny access request","description":"DELETE /scopes/requests/{request_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["request_id"],"properties":{"request_id":{"type":"string","description":"The ID of the request that you want to deny."}}}}}},"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/teammates-approve-access-request":{"post":{"operationId":"communication_sendgrid_teammates_approve_access_request","summary":"Approve access request","description":"PATCH /scopes/requests/{request_id}/approve","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["request_id"],"properties":{"request_id":{"type":"string","description":"The ID of the request that you want to approve."}}}}}},"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/sender-identities-api-get-all":{"get":{"operationId":"communication_sendgrid_sender_identities_api_get_all","summary":"Get all Sender Identities","description":"GET /senders","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/post-senders":{"post":{"operationId":"communication_sendgrid_post_senders","summary":"Create a Sender Identity","description":"POST /senders","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/sender-identities-api-view-sender-identity":{"get":{"operationId":"communication_sendgrid_sender_identities_api_view_sender_identity","summary":"View a Sender Identity","description":"GET /senders/{sender_id}","tags":["communication"],"parameters":[{"name":"sender_id","in":"query","required":true,"description":"The ID of the sender identity that you want to retrieve.","schema":{"type":"integer","description":"The ID of the sender identity that you want to retrieve."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/sender-identities-api-update-sender-identity":{"post":{"operationId":"communication_sendgrid_sender_identities_api_update_sender_identity","summary":"Update a Sender Identity","description":"PATCH /senders/{sender_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sender_id"],"properties":{"sender_id":{"type":"integer","description":"The ID of the sender identity that you want to retrieve."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/sender-identities-api-delete-sender-identity":{"post":{"operationId":"communication_sendgrid_sender_identities_api_delete_sender_identity","summary":"Delete a Sender Identity","description":"DELETE /senders/{sender_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sender_id"],"properties":{"sender_id":{"type":"integer","description":"The ID of the sender identity that you want to retrieve."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/sender-identities-api-resend-verification-email":{"post":{"operationId":"communication_sendgrid_sender_identities_api_resend_verification_email","summary":"Resend Sender Identity Verification","description":"POST /senders/{sender_id}/resend_verification","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sender_id"],"properties":{"sender_id":{"type":"integer","description":"The ID of the sender identity for which you would like to resend a verification email."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/certificates-create-ssocertificate":{"post":{"operationId":"communication_sendgrid_certificates_create_ssocertificate","summary":"Create an SSO Certificate","description":"POST /sso/certificates","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/certificates-get-individual":{"get":{"operationId":"communication_sendgrid_certificates_get_individual","summary":"Get an SSO Certificate","description":"GET /sso/certificates/{cert_id}","tags":["communication"],"parameters":[{"name":"cert_id","in":"query","required":true,"schema":{"type":"string"}}],"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/certificates-update-by-id":{"post":{"operationId":"communication_sendgrid_certificates_update_by_id","summary":"Update SSO Certificate","description":"PATCH /sso/certificates/{cert_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["cert_id"],"properties":{"cert_id":{"type":"string"},"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/certificates-delete-sso-certificate":{"post":{"operationId":"communication_sendgrid_certificates_delete_sso_certificate","summary":"Delete an SSO Certificate","description":"DELETE /sso/certificates/{cert_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["cert_id"],"properties":{"cert_id":{"type":"string"}}}}}},"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/single-sign-on-settings-get-all-sso-integrations":{"get":{"operationId":"communication_sendgrid_single_sign_on_settings_get_all_sso_integrations","summary":"Get All SSO Integrations","description":"GET /sso/integrations","tags":["communication"],"parameters":[{"name":"si","in":"query","required":false,"description":"If this parameter is set to `true`, the response will include the `completed_integration` field.","schema":{"type":"boolean","description":"If this parameter is set to `true`, the response will include the `completed_integration` field."}}],"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/single-sign-on-settings-create-integration":{"post":{"operationId":"communication_sendgrid_single_sign_on_settings_create_integration","summary":"Create an SSO Integration","description":"POST /sso/integrations","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/single-sign-on-settings-get-sso-integration-by-id":{"get":{"operationId":"communication_sendgrid_single_sign_on_settings_get_sso_integration_by_id","summary":"Get an SSO Integration","description":"GET /sso/integrations/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}},{"name":"si","in":"query","required":false,"description":"If this parameter is set to `true`, the response will include the `completed_integration` field.","schema":{"type":"boolean","description":"If this parameter is set to `true`, the response will include the `completed_integration` field."}}],"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/single-sign-on-settings-update-integration":{"post":{"operationId":"communication_sendgrid_single_sign_on_settings_update_integration","summary":"Update an SSO Integration","description":"PATCH /sso/integrations/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"si":{"type":"boolean","description":"If this parameter is set to `true`, the response will include the `completed_integration` field."},"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/single-sign-on-settings-delete-integration-by-id":{"post":{"operationId":"communication_sendgrid_single_sign_on_settings_delete_integration_by_id","summary":"Delete an SSO Integration","description":"DELETE /sso/integrations/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"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/certificates-get-by-idp-configurations":{"get":{"operationId":"communication_sendgrid_certificates_get_by_idp_configurations","summary":"Get All SSO Certificates by Integration","description":"GET /sso/integrations/{integration_id}/certificates","tags":["communication"],"parameters":[{"name":"integration_id","in":"query","required":true,"description":"An ID that matches a certificate to a specific IdP integration.","schema":{"type":"string","description":"An ID that matches a certificate to a specific IdP integration."}}],"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/single-sign-on-teammates-create-teammate":{"post":{"operationId":"communication_sendgrid_single_sign_on_teammates_create_teammate","summary":"Create SSO Teammate","description":"POST /sso/teammates","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/single-sign-on-teammates-edit-teammate":{"post":{"operationId":"communication_sendgrid_single_sign_on_teammates_edit_teammate","summary":"Edit an SSO Teammate","description":"PATCH /sso/teammates/{username}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username"],"properties":{"username":{"type":"string","description":"This email address must be the same address assigned to the teammate in your IdP"},"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/get-stats":{"get":{"operationId":"communication_sendgrid_get_stats","summary":"Retrieve global email statistics","description":"GET /stats","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}},{"name":"limit","in":"query","required":false,"description":"The number of results to return.","schema":{"type":"integer","description":"The number of results to return."}},{"name":"offset","in":"query","required":false,"description":"The point in the list to begin retrieving results.","schema":{"type":"integer","description":"The point in the list to begin retrieving results."}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}}],"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/get-subusers":{"get":{"operationId":"communication_sendgrid_get_subusers","summary":"List all Subusers","description":"GET /subusers","tags":["communication"],"parameters":[{"name":"username","in":"query","required":false,"description":"The username of this subuser.","schema":{"type":"string","description":"The username of this subuser."}},{"name":"limit","in":"query","required":false,"description":"The number of results you would like to get in each request.","schema":{"type":"integer","description":"The number of results you would like to get in each request."}},{"name":"offset","in":"query","required":false,"description":"The number of subusers to skip.","schema":{"type":"integer","description":"The number of subusers to skip."}}],"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/post-subusers":{"post":{"operationId":"communication_sendgrid_post_subusers","summary":"Create Subuser","description":"POST /subusers","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/subusers-api-get-subuser-reputations":{"get":{"operationId":"communication_sendgrid_subusers_api_get_subuser_reputations","summary":"Retrieve Subuser Reputations","description":"GET /subusers/reputations","tags":["communication"],"parameters":[{"name":"usernames","in":"query","required":false,"schema":{"type":"string"}}],"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/subuser-statistics-get-email-stats-for-subusers":{"get":{"operationId":"communication_sendgrid_subuser_statistics_get_email_stats_for_subusers","summary":"Retrieve email statistics for your subusers.","description":"GET /subusers/stats","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Limits the number of results returned per page.","schema":{"type":"integer","description":"Limits the number of results returned per page."}},{"name":"offset","in":"query","required":false,"description":"The point in the list to begin retrieving results from.","schema":{"type":"integer","description":"The point in the list to begin retrieving results from."}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\".","schema":{"type":"string","enum":["day","week","month"],"description":"How to group the statistics. Must be either \"day\", \"week\", or \"month\"."}},{"name":"subusers","in":"query","required":true,"description":"The subuser you want to retrieve statistics for. You may include this parameter up to 10 times to retrieve statistics for multiple subusers.","schema":{"type":"string","description":"The subuser you want to retrieve statistics for. You may include this parameter up to 10 times to retrieve statistics for multiple subusers."}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today."}}],"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/subuser-statistics-get-monthly-stats-for-all-subusers":{"get":{"operationId":"communication_sendgrid_subuser_statistics_get_monthly_stats_for_all_subusers","summary":"Retrieve monthly stats for all subusers","description":"GET /subusers/stats/monthly","tags":["communication"],"parameters":[{"name":"date","in":"query","required":true,"description":"The date of the month to retrieve statistics for. Must be formatted YYYY-MM-DD","schema":{"type":"string","description":"The date of the month to retrieve statistics for. Must be formatted YYYY-MM-DD"}},{"name":"subuser","in":"query","required":false,"description":"A substring search of your subusers.","schema":{"type":"string","description":"A substring search of your subusers."}},{"name":"sort_by_metric","in":"query","required":false,"description":"The metric that you want to sort by. Metrics that you can sort by are: `blocks`, `bounces`, `clicks`, `delivered`, `opens`, `requests`,…","schema":{"type":"string","enum":["blocks","bounces","clicks","delivered","opens","requests","unique_clicks","unique_opens","unsubscribes"],"default":"delivered","description":"The metric that you want to sort by. Metrics that you can sort by are: `blocks`, `bounces`, `clicks`, `delivered`, `opens`, `requests`,…"}},{"name":"sort_by_direction","in":"query","required":false,"description":"The direction you want to sort.","schema":{"type":"string","enum":["desc","asc"],"default":"desc","description":"The direction you want to sort."}},{"name":"limit","in":"query","required":false,"description":"Optional field to limit the number of results returned.","schema":{"type":"integer","default":5,"description":"Optional field to limit the number of results returned."}},{"name":"offset","in":"query","required":false,"description":"Optional beginning point in the list to retrieve from.","schema":{"type":"integer","default":0,"description":"Optional beginning point in the list to retrieve from."}}],"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/subuser-statistics-get-email-stats-for-subusers-2":{"get":{"operationId":"communication_sendgrid_subuser_statistics_get_email_stats_for_subusers_2","summary":"Retrieve the totals for each email statistic metric for all subusers.","description":"GET /subusers/stats/sums","tags":["communication"],"parameters":[{"name":"sort_by_direction","in":"query","required":false,"description":"The direction you want to sort.","schema":{"type":"string","enum":["desc","asc"],"default":"desc","description":"The direction you want to sort."}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD."}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."}},{"name":"limit","in":"query","required":false,"description":"Limits the number of results returned per page.","schema":{"type":"integer","default":5,"description":"Limits the number of results returned per page."}},{"name":"offset","in":"query","required":false,"description":"The point in the list to begin retrieving results from.","schema":{"type":"integer","default":0,"description":"The point in the list to begin retrieving results from."}},{"name":"aggregated_by","in":"query","required":false,"description":"How to group the statistics. Defaults to today. Must follow format YYYY-MM-DD.","schema":{"type":"string","description":"How to group the statistics. Defaults to today. Must follow format YYYY-MM-DD."}},{"name":"sort_by_metric","in":"query","required":false,"description":"The metric that you want to sort by. Must be a single metric.","schema":{"type":"string","default":"delivered","description":"The metric that you want to sort by. Must be a single metric."}}],"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/subusers-api-update-subuser-enable-state":{"post":{"operationId":"communication_sendgrid_subusers_api_update_subuser_enable_state","summary":"Enable/disable a subuser","description":"PATCH /subusers/{subuser_name}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subuser_name"],"properties":{"subuser_name":{"type":"string"},"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/subusers-api-delete-subuser":{"post":{"operationId":"communication_sendgrid_subusers_api_delete_subuser","summary":"Delete a subuser","description":"DELETE /subusers/{subuser_name}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subuser_name"],"properties":{"subuser_name":{"type":"string"}}}}}},"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/subusers-api-update-subuser-ips":{"post":{"operationId":"communication_sendgrid_subusers_api_update_subuser_ips","summary":"Update IPs assigned to a subuser","description":"PUT /subusers/{subuser_name}/ips","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subuser_name"],"properties":{"subuser_name":{"type":"string"},"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/subuser-monitor-settings-get-settings":{"get":{"operationId":"communication_sendgrid_subuser_monitor_settings_get_settings","summary":"Retrieve monitor settings for a subuser","description":"GET /subusers/{subuser_name}/monitor","tags":["communication"],"parameters":[{"name":"subuser_name","in":"query","required":true,"description":"The name of the subuser for which to retrieve monitor settings.","schema":{"type":"string","description":"The name of the subuser for which to retrieve monitor settings."}}],"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/subuser-monitor-settings-create-settings":{"post":{"operationId":"communication_sendgrid_subuser_monitor_settings_create_settings","summary":"Create monitor settings","description":"POST /subusers/{subuser_name}/monitor","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subuser_name"],"properties":{"subuser_name":{"type":"string","description":"The name of the subuser for which to retrieve monitor settings."},"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/subuser-monitor-settings-update-for-subuser-name-monitor":{"post":{"operationId":"communication_sendgrid_subuser_monitor_settings_update_for_subuser_name_monitor","summary":"Update Monitor Settings for a subuser","description":"PUT /subusers/{subuser_name}/monitor","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subuser_name"],"properties":{"subuser_name":{"type":"string","description":"The name of the subuser for which to retrieve monitor settings."},"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/subuser-monitor-settings-delete-monitor-settings":{"post":{"operationId":"communication_sendgrid_subuser_monitor_settings_delete_monitor_settings","summary":"Delete monitor settings","description":"DELETE /subusers/{subuser_name}/monitor","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subuser_name"],"properties":{"subuser_name":{"type":"string","description":"The name of the subuser for which to retrieve monitor settings."}}}}}},"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/subuser-statistics-get-monthly-email-stats-for-single-subuse":{"get":{"operationId":"communication_sendgrid_subuser_statistics_get_monthly_email_stats_for_single_subuse","summary":"Retrieve the monthly email statistics for a single subuser","description":"GET /subusers/{subuser_name}/stats/monthly","tags":["communication"],"parameters":[{"name":"subuser_name","in":"query","required":true,"schema":{"type":"string"}},{"name":"date","in":"query","required":true,"description":"The date of the month to retrieve statistics for. Must be formatted YYYY-MM-DD","schema":{"type":"string","description":"The date of the month to retrieve statistics for. Must be formatted YYYY-MM-DD"}},{"name":"sort_by_metric","in":"query","required":false,"description":"The metric that you want to sort by. Metrics that you can sort by are: `blocks`, `bounces`, `clicks`, `delivered`, `opens`, `requests`,…","schema":{"type":"string","default":"delivered","description":"The metric that you want to sort by. Metrics that you can sort by are: `blocks`, `bounces`, `clicks`, `delivered`, `opens`, `requests`,…"}},{"name":"sort_by_direction","in":"query","required":false,"description":"The direction you want to sort.","schema":{"type":"string","enum":["desc","asc"],"default":"desc","description":"The direction you want to sort."}},{"name":"limit","in":"query","required":false,"description":"Optional field to limit the number of results returned.","schema":{"type":"integer","default":5,"description":"Optional field to limit the number of results returned."}},{"name":"offset","in":"query","required":false,"description":"Optional beginning point in the list to retrieve from.","schema":{"type":"integer","default":0,"description":"Optional beginning point in the list to retrieve from."}}],"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/blocks-api-get-all-email-addresses":{"get":{"operationId":"communication_sendgrid_blocks_api_get_all_email_addresses","summary":"Retrieve all blocks","description":"GET /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 the number of results to be displayed per page.","schema":{"type":"integer","description":"Limit the number of results to be displayed per page."}},{"name":"offset","in":"query","required":false,"description":"The point in the list to begin displaying results.","schema":{"type":"integer","description":"The point in the list to begin displaying results."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/blocks-api-delete-all-blocked-emails":{"post":{"operationId":"communication_sendgrid_blocks_api_delete_all_blocked_emails","summary":"Delete blocks","description":"DELETE /suppression/blocks","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/blocks-api-get-specific-block":{"get":{"operationId":"communication_sendgrid_blocks_api_get_specific_block","summary":"Retrieve a specific block","description":"GET /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,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/blocks-api-delete-specific-block":{"post":{"operationId":"communication_sendgrid_blocks_api_delete_specific_block","summary":"Delete a specific block","description":"DELETE /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","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/bounces-api-get-all-bounces":{"get":{"operationId":"communication_sendgrid_bounces_api_get_all_bounces","summary":"Retrieve all bounces","description":"GET /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":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/bounces-api-delete-bounces":{"post":{"operationId":"communication_sendgrid_bounces_api_delete_bounces","summary":"Delete bounces","description":"DELETE /suppression/bounces","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/bounces-api-get-by-email-address":{"get":{"operationId":"communication_sendgrid_bounces_api_get_by_email_address","summary":"Retrieve a Bounce","description":"GET /suppression/bounces/{email}","tags":["communication"],"parameters":[{"name":"email","in":"query","required":true,"schema":{"type":"string"}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/bounces-api-remove-bounce":{"post":{"operationId":"communication_sendgrid_bounces_api_remove_bounce","summary":"Delete a bounce","description":"DELETE /suppression/bounces/{email}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email","email_address"],"properties":{"email":{"type":"string"},"email_address":{"type":"string","description":"The email address you would like to remove from the bounce list."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/invalid-emails-api-get-all-invalid-emails":{"get":{"operationId":"communication_sendgrid_invalid_emails_api_get_all_invalid_emails","summary":"Retrieve all invalid emails","description":"GET /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 the number of results to be displayed per page.","schema":{"type":"integer","description":"Limit the number of results to be displayed per page."}},{"name":"offset","in":"query","required":false,"description":"Paging offset. The point in the list to begin displaying results.","schema":{"type":"integer","description":"Paging offset. The point in the list to begin displaying results."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/invalid-emails-api-delete-invalid-emails":{"post":{"operationId":"communication_sendgrid_invalid_emails_api_delete_invalid_emails","summary":"Delete invalid emails","description":"DELETE /suppression/invalid_emails","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/invalid-emails-api-get-specific-invalid-email":{"get":{"operationId":"communication_sendgrid_invalid_emails_api_get_specific_invalid_email","summary":"Retrieve a specific invalid email","description":"GET /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,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/invalid-emails-api-remove-specific-email":{"post":{"operationId":"communication_sendgrid_invalid_emails_api_remove_specific_email","summary":"Delete a specific invalid email","description":"DELETE /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","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/spam-reports-api-get-all-reports":{"get":{"operationId":"communication_sendgrid_spam_reports_api_get_all_reports","summary":"Retrieve all spam reports","description":"GET /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 the number of results to be displayed per page.","schema":{"type":"integer","description":"Limit the number of results to be displayed per page."}},{"name":"offset","in":"query","required":false,"description":"Paging offset. The point in the list to begin displaying results.","schema":{"type":"integer","description":"Paging offset. The point in the list to begin displaying results."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/spam-reports-api-delete-reports":{"post":{"operationId":"communication_sendgrid_spam_reports_api_delete_reports","summary":"Delete spam reports","description":"DELETE /suppression/spam_reports","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/spam-reports-api-get-specific-report-by-email":{"get":{"operationId":"communication_sendgrid_spam_reports_api_get_specific_report_by_email","summary":"Retrieve a specific spam report","description":"GET /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,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/spam-reports-api-delete-specific-report-by-email-address":{"post":{"operationId":"communication_sendgrid_spam_reports_api_delete_specific_report_by_email_address","summary":"Delete a specific spam report","description":"DELETE /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","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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-global-suppressions-get-all-addresses":{"get":{"operationId":"communication_sendgrid_suppressions_global_suppressions_get_all_addresses","summary":"Retrieve all global suppressions","description":"GET /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":"The number of results to display on each page.","schema":{"type":"integer","description":"The number of results to display on each page."}},{"name":"offset","in":"query","required":false,"description":"The point in the list of results to begin displaying global suppressions.","schema":{"type":"integer","description":"The point in the list of results to begin displaying global suppressions."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/teammates-get-all-teammates":{"get":{"operationId":"communication_sendgrid_teammates_get_all_teammates","summary":"Retrieve all teammates","description":"GET /teammates","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of items to return","schema":{"type":"integer","default":500,"description":"Number of items to return"}},{"name":"offset","in":"query","required":false,"description":"Paging offset","schema":{"type":"integer","default":0,"description":"Paging offset"}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/teammates-invite-teammate":{"post":{"operationId":"communication_sendgrid_teammates_invite_teammate","summary":"Invite teammate","description":"POST /teammates","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/teammates-get-all-pending":{"get":{"operationId":"communication_sendgrid_teammates_get_all_pending","summary":"Retrieve all pending teammates","description":"GET /teammates/pending","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/teammates-delete-pending-teammate":{"post":{"operationId":"communication_sendgrid_teammates_delete_pending_teammate","summary":"Delete pending teammate","description":"DELETE /teammates/pending/{token}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["token"],"properties":{"token":{"type":"string","description":"The token for the invite you want to delete."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/teammates-resend-teammate-invite":{"post":{"operationId":"communication_sendgrid_teammates_resend_teammate_invite","summary":"Resend teammate invite","description":"POST /teammates/pending/{token}/resend","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["token"],"properties":{"token":{"type":"string","description":"The token for the invite that you want to resend."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/teammates-get-by-username":{"get":{"operationId":"communication_sendgrid_teammates_get_by_username","summary":"Retrieve specific teammate","description":"GET /teammates/{username}","tags":["communication"],"parameters":[{"name":"username","in":"query","required":true,"description":"The username of the teammate that you want to retrieve.","schema":{"type":"string","description":"The username of the teammate that you want to retrieve."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/teammates-update-permissions":{"post":{"operationId":"communication_sendgrid_teammates_update_permissions","summary":"Update teammate's permissions","description":"PATCH /teammates/{username}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username"],"properties":{"username":{"type":"string","description":"The username of the teammate that you want to retrieve."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/teammates-remove-teammate":{"post":{"operationId":"communication_sendgrid_teammates_remove_teammate","summary":"Delete teammate","description":"DELETE /teammates/{username}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username"],"properties":{"username":{"type":"string","description":"The username of the teammate that you want to retrieve."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/get-templates":{"get":{"operationId":"communication_sendgrid_get_templates","summary":"Retrieve paged transactional templates.","description":"GET /templates","tags":["communication"],"parameters":[{"name":"generations","in":"query","required":false,"description":"Comma-delimited list specifying which generations of templates to return. Options are `legacy`, `dynamic` or `legacy,dynamic`.","schema":{"type":"string","enum":["legacy","dynamic","legacy,dynamic"],"default":"legacy","description":"Comma-delimited list specifying which generations of templates to return. Options are `legacy`, `dynamic` or `legacy,dynamic`."}},{"name":"page_size","in":"query","required":true,"description":"The number of templates to be returned in each page of results","schema":{"type":"number","description":"The number of templates to be returned in each page of results"}},{"name":"page_token","in":"query","required":false,"description":"A token corresponding to a specific page of results, as provided by metadata","schema":{"type":"string","description":"A token corresponding to a specific page of results, as provided by metadata"}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/post-templates":{"post":{"operationId":"communication_sendgrid_post_templates","summary":"Create a transactional template.","description":"POST /templates","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/transactional-templates-get-single-template":{"get":{"operationId":"communication_sendgrid_transactional_templates_get_single_template","summary":"Retrieve a single transactional template.","description":"GET /templates/{template_id}","tags":["communication"],"parameters":[{"name":"template_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/transactional-templates-duplicate-template":{"post":{"operationId":"communication_sendgrid_transactional_templates_duplicate_template","summary":"Duplicate a transactional template.","description":"POST /templates/{template_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["template_id"],"properties":{"template_id":{"type":"string"},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/transactional-templates-edit-template-name":{"post":{"operationId":"communication_sendgrid_transactional_templates_edit_template_name","summary":"Edit a transactional template.","description":"PATCH /templates/{template_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["template_id"],"properties":{"template_id":{"type":"string"},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/transactional-templates-delete-template":{"post":{"operationId":"communication_sendgrid_transactional_templates_delete_template","summary":"Delete a template.","description":"DELETE /templates/{template_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["template_id"],"properties":{"template_id":{"type":"string"},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/transactional-templates-versions-create-new-version":{"post":{"operationId":"communication_sendgrid_transactional_templates_versions_create_new_version","summary":"Create a new transactional template version.","description":"POST /templates/{template_id}/versions","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["template_id"],"properties":{"template_id":{"type":"string"},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/transactional-templates-versions-get-specific-version":{"get":{"operationId":"communication_sendgrid_transactional_templates_versions_get_specific_version","summary":"Retrieve a specific transactional template version.","description":"GET /templates/{template_id}/versions/{version_id}","tags":["communication"],"parameters":[{"name":"template_id","in":"query","required":true,"description":"The ID of the original template","schema":{"type":"string","description":"The ID of the original template"}},{"name":"version_id","in":"query","required":true,"description":"The ID of the template version","schema":{"type":"string","description":"The ID of the template version"}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/transactional-templates-versions-edit-content":{"post":{"operationId":"communication_sendgrid_transactional_templates_versions_edit_content","summary":"Edit a transactional template version.","description":"PATCH /templates/{template_id}/versions/{version_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["template_id","version_id"],"properties":{"template_id":{"type":"string","description":"The ID of the original template"},"version_id":{"type":"string","description":"The ID of the template version"},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/transactional-templates-versions-delete-template-version":{"post":{"operationId":"communication_sendgrid_transactional_templates_versions_delete_template_version","summary":"Delete a transactional template version.","description":"DELETE /templates/{template_id}/versions/{version_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["template_id","version_id"],"properties":{"template_id":{"type":"string","description":"The ID of the original template"},"version_id":{"type":"string","description":"The ID of the template version"},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/transactional-templates-versions-activate-version":{"post":{"operationId":"communication_sendgrid_transactional_templates_versions_activate_version","summary":"Activate a transactional template version.","description":"POST /templates/{template_id}/versions/{version_id}/activate","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["template_id","version_id"],"properties":{"template_id":{"type":"string","description":"The ID of the original template"},"version_id":{"type":"string","description":"The ID of the template version"},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/settings-tracking-get-all-tracking":{"get":{"operationId":"communication_sendgrid_settings_tracking_get_all_tracking","summary":"Retrieve Tracking Settings","description":"GET /tracking_settings","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/settings-tracking-get-click-tracking-setting":{"get":{"operationId":"communication_sendgrid_settings_tracking_get_click_tracking_setting","summary":"Retrieve Click Track Settings","description":"GET /tracking_settings/click","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/settings-tracking-update-click-tracking-setting":{"post":{"operationId":"communication_sendgrid_settings_tracking_update_click_tracking_setting","summary":"Update Click Tracking Settings","description":"PATCH /tracking_settings/click","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/settings-tracking-get-google-analytics-settings":{"get":{"operationId":"communication_sendgrid_settings_tracking_get_google_analytics_settings","summary":"Retrieve Google Analytics Settings","description":"GET /tracking_settings/google_analytics","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/settings-tracking-update-google-analytics-settings":{"post":{"operationId":"communication_sendgrid_settings_tracking_update_google_analytics_settings","summary":"Update Google Analytics Settings","description":"PATCH /tracking_settings/google_analytics","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/settings-tracking-get-open-settings":{"get":{"operationId":"communication_sendgrid_settings_tracking_get_open_settings","summary":"Get Open Tracking Settings","description":"GET /tracking_settings/open","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/settings-tracking-update-open-tracking-settings":{"post":{"operationId":"communication_sendgrid_settings_tracking_update_open_tracking_settings","summary":"Update Open Tracking Settings","description":"PATCH /tracking_settings/open","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/settings-tracking-get-subscription-tracking-settings":{"get":{"operationId":"communication_sendgrid_settings_tracking_get_subscription_tracking_settings","summary":"Retrieve Subscription Tracking Settings","description":"GET /tracking_settings/subscription","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/settings-tracking-update-subscription-tracking-settings":{"post":{"operationId":"communication_sendgrid_settings_tracking_update_subscription_tracking_settings","summary":"Update Subscription Tracking Settings","description":"PATCH /tracking_settings/subscription","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/users-api-get-user-account-information":{"get":{"operationId":"communication_sendgrid_users_api_get_user_account_information","summary":"Get a user's account information.","description":"GET /user/account","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/users-api-get-credit-balance":{"get":{"operationId":"communication_sendgrid_users_api_get_credit_balance","summary":"Retrieve your credit balance","description":"GET /user/credits","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/users-api-get-account-email-address":{"get":{"operationId":"communication_sendgrid_users_api_get_account_email_address","summary":"Retrieve your account email address","description":"GET /user/email","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/users-api-update-email":{"post":{"operationId":"communication_sendgrid_users_api_update_email","summary":"Update your account email address","description":"PUT /user/email","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/users-api-update-password":{"post":{"operationId":"communication_sendgrid_users_api_update_password","summary":"Update your password","description":"PUT /user/password","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/users-api-get-user-profile":{"get":{"operationId":"communication_sendgrid_users_api_get_user_profile","summary":"Get a user's profile","description":"GET /user/profile","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/users-api-update-user-profile":{"post":{"operationId":"communication_sendgrid_users_api_update_user_profile","summary":"Update a user's profile","description":"PATCH /user/profile","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/cancel-scheduled-sends-all-scheduled-sends":{"get":{"operationId":"communication_sendgrid_cancel_scheduled_sends_all_scheduled_sends","summary":"Retrieve all scheduled sends","description":"GET /user/scheduled_sends","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/cancel-scheduled-sends-by-batch-id-status":{"post":{"operationId":"communication_sendgrid_cancel_scheduled_sends_by_batch_id_status","summary":"Cancel or pause a scheduled send","description":"POST /user/scheduled_sends","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/cancel-scheduled-sends-by-batch-id":{"get":{"operationId":"communication_sendgrid_cancel_scheduled_sends_by_batch_id","summary":"Retrieve scheduled send","description":"GET /user/scheduled_sends/{batch_id}","tags":["communication"],"parameters":[{"name":"batch_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/cancel-scheduled-sends-update-status":{"post":{"operationId":"communication_sendgrid_cancel_scheduled_sends_update_status","summary":"Update a scheduled send","description":"PATCH /user/scheduled_sends/{batch_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["batch_id"],"properties":{"batch_id":{"type":"string"},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/cancel-scheduled-sends-cancellation-pause":{"post":{"operationId":"communication_sendgrid_cancel_scheduled_sends_cancellation_pause","summary":"Delete a cancellation or pause from a scheduled send","description":"DELETE /user/scheduled_sends/{batch_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["batch_id"],"properties":{"batch_id":{"type":"string"},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/settings-enforced-tls-get-current-enforced-tls-settings":{"get":{"operationId":"communication_sendgrid_settings_enforced_tls_get_current_enforced_tls_settings","summary":"Retrieve current Enforced TLS settings.","description":"GET /user/settings/enforced_tls","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/settings-enforced-tls-update-enforced-tls-settings":{"post":{"operationId":"communication_sendgrid_settings_enforced_tls_update_enforced_tls_settings","summary":"Update Enforced TLS settings","description":"PATCH /user/settings/enforced_tls","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/users-api-get-username":{"get":{"operationId":"communication_sendgrid_users_api_get_username","summary":"Retrieve your username","description":"GET /user/username","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/users-api-update-username":{"post":{"operationId":"communication_sendgrid_users_api_update_username","summary":"Update your username","description":"PUT /user/username","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/webhooks-get-event-settings":{"get":{"operationId":"communication_sendgrid_webhooks_get_event_settings","summary":"Retrieve Event Webhook settings","description":"GET /user/webhooks/event/settings","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/webhooks-update-event-notification-settings":{"post":{"operationId":"communication_sendgrid_webhooks_update_event_notification_settings","summary":"Update Event Notification Settings","description":"PATCH /user/webhooks/event/settings","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/webhooks-get-signed-webhook-public-key":{"get":{"operationId":"communication_sendgrid_webhooks_get_signed_webhook_public_key","summary":"Retrieve Signed Webhook Public Key","description":"GET /user/webhooks/event/settings/signed","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/webhooks-enable-signed-webhook":{"post":{"operationId":"communication_sendgrid_webhooks_enable_signed_webhook","summary":"Enable/Disable Signed Webhook","description":"PATCH /user/webhooks/event/settings/signed","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/webhooks-test-event-notification-settings":{"post":{"operationId":"communication_sendgrid_webhooks_test_event_notification_settings","summary":"Test Event Notification Settings","description":"POST /user/webhooks/event/test","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/webhooks-get-parse-settings":{"get":{"operationId":"communication_sendgrid_webhooks_get_parse_settings","summary":"Retrieve all parse settings","description":"GET /user/webhooks/parse/settings","tags":["communication"],"parameters":[{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/settings-inbound-parse-create-setting":{"post":{"operationId":"communication_sendgrid_settings_inbound_parse_create_setting","summary":"Create a parse setting","description":"POST /user/webhooks/parse/settings","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/settings-inbound-parse-get-specific-parse-setting-by-hostnam":{"get":{"operationId":"communication_sendgrid_settings_inbound_parse_get_specific_parse_setting_by_hostnam","summary":"Retrieve a specific parse setting","description":"GET /user/webhooks/parse/settings/{hostname}","tags":["communication"],"parameters":[{"name":"hostname","in":"query","required":true,"description":"The hostname associated with the inbound parse setting that you would like to retrieve.","schema":{"type":"string","description":"The hostname associated with the inbound parse setting that you would like to retrieve."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/settings-inbound-parse-update-hostname-setting":{"post":{"operationId":"communication_sendgrid_settings_inbound_parse_update_hostname_setting","summary":"Update a parse setting","description":"PATCH /user/webhooks/parse/settings/{hostname}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hostname"],"properties":{"hostname":{"type":"string","description":"The hostname associated with the inbound parse setting that you would like to retrieve."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/settings-inbound-parse-delete-setting-by-hostname":{"post":{"operationId":"communication_sendgrid_settings_inbound_parse_delete_setting_by_hostname","summary":"Delete a parse setting","description":"DELETE /user/webhooks/parse/settings/{hostname}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hostname"],"properties":{"hostname":{"type":"string","description":"The hostname associated with the inbound parse setting that you would like to retrieve."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/webhooks-get-parse-stats":{"get":{"operationId":"communication_sendgrid_webhooks_get_parse_stats","summary":"Retrieves Inbound Parse Webhook statistics.","description":"GET /user/webhooks/parse/stats","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"The number of statistics to return on each page.","schema":{"type":"string","description":"The number of statistics to return on each page."}},{"name":"offset","in":"query","required":false,"description":"The number of statistics to skip.","schema":{"type":"string","description":"The number of statistics to skip."}},{"name":"aggregated_by","in":"query","required":false,"description":"How you would like the statistics to by grouped.","schema":{"type":"string","enum":["day","week","month"],"description":"How you would like the statistics to by grouped."}},{"name":"start_date","in":"query","required":true,"description":"The starting date of the statistics you want to retrieve. Must be in the format YYYY-MM-DD","schema":{"type":"string","description":"The starting date of the statistics you want to retrieve. Must be in the format YYYY-MM-DD"}},{"name":"end_date","in":"query","required":false,"description":"The end date of the statistics you want to retrieve. Must be in the format YYYY-MM-DD","schema":{"type":"string","default":"The day the request is made.","description":"The end date of the statistics you want to retrieve. Must be in the format YYYY-MM-DD"}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/email-address-validation-check-validity":{"post":{"operationId":"communication_sendgrid_email_address_validation_check_validity","summary":"Validate an email","description":"POST /validations/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/sender-verification-get-all-sender-identities":{"get":{"operationId":"communication_sendgrid_sender_verification_get_all_sender_identities","summary":"Get All Verified Senders","description":"GET /verified_senders","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"number"}},{"name":"lastSeenID","in":"query","required":false,"schema":{"type":"number"}},{"name":"id","in":"query","required":false,"schema":{"type":"integer"}}],"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/sender-verification-create-verified-sender-request":{"post":{"operationId":"communication_sendgrid_sender_verification_create_verified_sender_request","summary":"Create Verified Sender Request","description":"POST /verified_senders","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/sender-verification-list-domain-warn":{"get":{"operationId":"communication_sendgrid_sender_verification_list_domain_warn","summary":"Domain Warn List","description":"GET /verified_senders/domains","tags":["communication"],"parameters":[],"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/sender-verification-resend-verification-email":{"post":{"operationId":"communication_sendgrid_sender_verification_resend_verification_email","summary":"Resend Verified Sender Request","description":"POST /verified_senders/resend/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"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/sender-verification-determine-verification-status":{"get":{"operationId":"communication_sendgrid_sender_verification_determine_verification_status","summary":"Completed Steps","description":"GET /verified_senders/steps_completed","tags":["communication"],"parameters":[],"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/sender-verification-request-verification-token":{"get":{"operationId":"communication_sendgrid_sender_verification_request_verification_token","summary":"Verify Sender Request","description":"GET /verified_senders/verify/{token}","tags":["communication"],"parameters":[{"name":"token","in":"query","required":true,"schema":{"type":"string"}}],"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/sender-verification-update-sender-identity":{"post":{"operationId":"communication_sendgrid_sender_verification_update_sender_identity","summary":"Edit Verified Sender","description":"PATCH /verified_senders/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"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/sender-verification-delete-verified-sender":{"post":{"operationId":"communication_sendgrid_sender_verification_delete_verified_sender","summary":"Delete Verified Sender","description":"DELETE /verified_senders/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"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/email-cname-records-send-dns-email":{"post":{"operationId":"communication_sendgrid_email_cname_records_send_dns_email","summary":"Email DNS records to a co-worker","description":"POST /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-get-all-domains":{"get":{"operationId":"communication_sendgrid_domain_authentication_get_all_domains","summary":"List all authenticated domains","description":"GET /whitelabel/domains","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of domains to return.","schema":{"type":"integer","description":"Number of domains to return."}},{"name":"offset","in":"query","required":false,"description":"Paging offset.","schema":{"type":"integer","description":"Paging offset."}},{"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,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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-post-authenticate-domain":{"post":{"operationId":"communication_sendgrid_domain_authentication_post_authenticate_domain","summary":"Authenticate a domain","description":"POST /whitelabel/domains","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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-get-default-authentication":{"get":{"operationId":"communication_sendgrid_domain_authentication_get_default_authentication","summary":"Get the default authentication","description":"GET /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,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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-list-subuser-domains":{"get":{"operationId":"communication_sendgrid_domain_authentication_list_subuser_domains","summary":"List the authenticated domain associated with the given user.","description":"GET /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-disassociate-domain-from-subuser":{"post":{"operationId":"communication_sendgrid_domain_authentication_disassociate_domain_from_subuser","summary":"Disassociate an authenticated domain from a given user.","description":"DELETE /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-get-specific-domain":{"get":{"operationId":"communication_sendgrid_domain_authentication_get_specific_domain","summary":"Retrieve an authenticated domain","description":"GET /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,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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-update-domain-settings":{"post":{"operationId":"communication_sendgrid_domain_authentication_update_domain_settings","summary":"Update an authenticated domain","description":"PATCH /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","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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-delete-authenticated-domain":{"post":{"operationId":"communication_sendgrid_domain_authentication_delete_authenticated_domain","summary":"Delete an authenticated domain.","description":"DELETE /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","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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-associate-subuser-with-domain":{"post":{"operationId":"communication_sendgrid_domain_authentication_associate_subuser_with_domain","summary":"Associate an authenticated domain with a given user.","description":"POST /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-add-ip-to-domain":{"post":{"operationId":"communication_sendgrid_domain_authentication_add_ip_to_domain","summary":"Add an IP to an authenticated domain","description":"POST /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","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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-remove-ip":{"post":{"operationId":"communication_sendgrid_domain_authentication_remove_ip","summary":"Remove an IP from an authenticated domain.","description":"DELETE /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","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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-validate-domain":{"post":{"operationId":"communication_sendgrid_domain_authentication_validate_domain","summary":"Validate a domain authentication.","description":"POST /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","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/reverse-dns-get-all-reverse-dns-records":{"get":{"operationId":"communication_sendgrid_reverse_dns_get_all_reverse_dns_records","summary":"Retrieve all reverse DNS records","description":"GET /whitelabel/ips","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"The maximum number of results to retrieve.","schema":{"type":"integer","description":"The maximum number of results to retrieve."}},{"name":"offset","in":"query","required":false,"description":"The point in the list of results to begin retrieving IP addresses from.","schema":{"type":"integer","description":"The point in the list of results to begin retrieving IP addresses from."}},{"name":"ip","in":"query","required":false,"description":"The IP address segment that you'd like to use in a prefix search.","schema":{"type":"string","description":"The IP address segment that you'd like to use in a prefix search."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/reverse-dns-set-up-reverse-dns":{"post":{"operationId":"communication_sendgrid_reverse_dns_set_up_reverse_dns","summary":"Set up reverse DNS","description":"POST /whitelabel/ips","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/reverse-dns-get-record":{"get":{"operationId":"communication_sendgrid_reverse_dns_get_record","summary":"Retrieve a reverse DNS record","description":"GET /whitelabel/ips/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the reverse DNS record that you would like to retrieve.","schema":{"type":"string","description":"The ID of the reverse DNS record that you would like to retrieve."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/reverse-dns-delete-reverse-dns-record":{"post":{"operationId":"communication_sendgrid_reverse_dns_delete_reverse_dns_record","summary":"Delete a reverse DNS record","description":"DELETE /whitelabel/ips/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the reverse DNS record that you would like to retrieve."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/reverse-dns-validate-record":{"post":{"operationId":"communication_sendgrid_reverse_dns_validate_record","summary":"Validate a reverse DNS record","description":"POST /whitelabel/ips/{id}/validate","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the reverse DNS record that you would like to validate."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/link-branding-get-branded-links":{"get":{"operationId":"communication_sendgrid_link_branding_get_branded_links","summary":"Retrieve all branded links","description":"GET /whitelabel/links","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Limits the number of results returned per page.","schema":{"type":"integer","description":"Limits the number of results returned per page."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/link-branding-create-branded-link":{"post":{"operationId":"communication_sendgrid_link_branding_create_branded_link","summary":"Create a branded link","description":"POST /whitelabel/links","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/link-branding-get-default-branded-link":{"get":{"operationId":"communication_sendgrid_link_branding_get_default_branded_link","summary":"Retrieve the default branded link","description":"GET /whitelabel/links/default","tags":["communication"],"parameters":[{"name":"domain","in":"query","required":false,"description":"The domain to match against when finding the default branded link.","schema":{"type":"string","description":"The domain to match against when finding the default branded link."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/link-branding-get-subuser-branded-link":{"get":{"operationId":"communication_sendgrid_link_branding_get_subuser_branded_link","summary":"Retrieve a subuser's branded link","description":"GET /whitelabel/links/subuser","tags":["communication"],"parameters":[{"name":"username","in":"query","required":true,"description":"The username of the subuser to retrieve associated branded links for.","schema":{"type":"string","description":"The username of the subuser to retrieve associated branded links for."}}],"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/link-branding-disassociate-branded-link-from-subuser":{"post":{"operationId":"communication_sendgrid_link_branding_disassociate_branded_link_from_subuser","summary":"Disassociate a branded link from a subuser","description":"DELETE /whitelabel/links/subuser","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username"],"properties":{"username":{"type":"string","description":"The username of the subuser account that you want to disassociate a branded link from."}}}}}},"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/link-branding-get-branded-link-by-id":{"get":{"operationId":"communication_sendgrid_link_branding_get_branded_link_by_id","summary":"Retrieve a branded link","description":"GET /whitelabel/links/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the branded link you want to retrieve.","schema":{"type":"integer","description":"The ID of the branded link you want to retrieve."}},{"name":"on-behalf-of","in":"query","required":false,"schema":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}],"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/link-branding-update-branded-link":{"post":{"operationId":"communication_sendgrid_link_branding_update_branded_link","summary":"Update a branded link","description":"PATCH /whitelabel/links/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The ID of the branded link you want to retrieve."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."},"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/link-branding-delete-branded-link":{"post":{"operationId":"communication_sendgrid_link_branding_delete_branded_link","summary":"Delete a branded link","description":"DELETE /whitelabel/links/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The ID of the branded link you want to retrieve."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/link-branding-validate-branded-link":{"post":{"operationId":"communication_sendgrid_link_branding_validate_branded_link","summary":"Validate a branded link","description":"POST /whitelabel/links/{id}/validate","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The ID of the branded link that you want to validate."},"on-behalf-of":{"type":"string","default":"The subuser's username. This header generates the API call as if the subuser account was making the call."}}}}}},"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/link-branding-associate-branded-link-with-subuser":{"post":{"operationId":"communication_sendgrid_link_branding_associate_branded_link_with_subuser","summary":"Associate a branded link with a subuser","description":"POST /whitelabel/links/{link_id}/subuser","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["link_id"],"properties":{"link_id":{"type":"integer","description":"The ID of the branded link you want to associate."},"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"}}},"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"}}}}}}}