tools-manifest.json

{
  "api_name": "sendgrid",
  "base_url": "https://api.sendgrid.com",
  "description": "Bundled Twilio SendGrid OpenAPI spec from twilio/sendgrid-oai (46 resource files merged).",
  "mcp_ready": "full",
  "http_transport": "standard",
  "auth": {
    "type": "bearer_token",
    "header": "Authorization",
    "env_vars": [
      "SENDGRID_API_KEY"
    ],
    "env_var_specs": [
      {
        "name": "SENDGRID_API_KEY",
        "kind": "per_call",
        "required": true,
        "sensitive": true,
        "inferred": true
      }
    ]
  },
  "required_headers": [],
  "tools": [
    {
      "name": "access-settings_add-ip-to-allow-list",
      "description": "**This endpoint allows you to add one or more allowed IP addresses.** To allow one or more IP addresses, pass them to this endpoint in an array. Once an IP address is added to your allow list, it will be assigned an `id` that can be used to remove the address. You can retrieve the ID associated with an IP using the 'Retrieve a list of currently allowed IPs' endpoint. Required: ips. Returns the new IpAccessManagement2xx.",
      "method": "POST",
      "path": "/v3/access_settings/whitelist",
      "params": [
        {
          "name": "ips",
          "type": "array",
          "location": "body",
          "description": "An array containing the IP(s) you want to allow.",
          "required": true
        }
      ]
    },
    {
      "name": "access-settings_delete-allowed-ip",
      "description": "**This endpoint allows you to remove a specific IP address from your list of allowed addresses.** When removing a specific IP address from your list, you must include the ID in your call. You can retrieve the IDs associated with your allowed IP addresses using the 'Retrieve a list of currently allowed IPs' endpoint. Required: rule_id. Destructive.",
      "method": "DELETE",
      "path": "/v3/access_settings/whitelist/{rule_id}",
      "params": [
        {
          "name": "rule_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the allowed IP address that you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "access-settings_delete-allowed-ips",
      "description": "**This endpoint allows you to remove one or more IP addresses from your list of allowed addresses.** To remove one or more IP addresses, pass this endpoint an array containing the ID(s) associated with the IP(s) you intend to remove. You can retrieve the IDs associated with your allowed IP addresses using the 'Retrieve a list of currently allowed IPs' endpoint. It is possible to remove your own IP address, which will block access to your account. You will need to submit a [support ticket](https://sendgrid.com/docs/ui/account-and-settings/support/) if this happens. For this reason, it is important to double check that you are removing only the IPs you intend to remove when using this endpoint. Optional: ids. Destructive.",
      "method": "DELETE",
      "path": "/v3/access_settings/whitelist",
      "params": [
        {
          "name": "ids",
          "type": "array",
          "location": "body",
          "description": "An array of the IDs of the IP address that you want to remove from your allow list."
        }
      ]
    },
    {
      "name": "access-settings_get-allowed-ip",
      "description": "**This endpoint allows you to retreive a specific IP address that has been allowed to access your account.** You must include the ID for the specific IP address you want to retrieve in your call. You can retrieve the IDs associated with your allowed IP addresses using the 'Retrieve a list of currently allowed IPs' endpoint. Required: rule_id. Returns the IpAccessManagement2xx.",
      "method": "GET",
      "path": "/v3/access_settings/whitelist/{rule_id}",
      "params": [
        {
          "name": "rule_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the allowed IP address that you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "access-settings_list-access-activity",
      "description": "**This endpoint allows you to retrieve a list of all of the IP addresses that recently attempted to access your account either through the User Interface or the API.**. Optional: limit (default: 20). Returns the AccessSettingsListAccessActivityResponse.",
      "method": "GET",
      "path": "/v3/access_settings/activity",
      "params": [
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "Limits the number of IPs to return."
        }
      ]
    },
    {
      "name": "access-settings_list-allowed-ip",
      "description": "**This endpoint allows you to retrieve a list of IP addresses that are currently allowed to access your account.** Each IP address returned to you will have `created_at` and `updated_at` dates. Each IP will also be associated with an `id` that can be used to remove the address from your allow list. Returns the IpAccessManagement2xx.",
      "method": "GET",
      "path": "/v3/access_settings/whitelist",
      "params": []
    },
    {
      "name": "alerts_create",
      "description": "**This endpoint allows you to create a new alert.**. Required: email_to, type. Optional: frequency, percentage. Returns the new AlertsCreateResponse.",
      "method": "POST",
      "path": "/v3/alerts",
      "params": [
        {
          "name": "email_to",
          "type": "string",
          "location": "body",
          "description": "The email address the alert will be sent to. Example: test@example.com",
          "required": true
        },
        {
          "name": "frequency",
          "type": "string",
          "location": "body",
          "description": "Required for stats_notification. How frequently the alert will be sent. Example: daily"
        },
        {
          "name": "percentage",
          "type": "int",
          "location": "body",
          "description": "Required for usage_limit. When this usage threshold is reached, the alert will be sent. Example: 90"
        },
        {
          "name": "type",
          "type": "string",
          "location": "body",
          "description": "The type of alert you want to create. Can be either usage_limit or stats_notification. Example: usage_limit",
          "required": true
        }
      ]
    },
    {
      "name": "alerts_delete",
      "description": "**This endpoint allows you to delete an alert.**. Required: alert_id. Destructive.",
      "method": "DELETE",
      "path": "/v3/alerts/{alert_id}",
      "params": [
        {
          "name": "alert_id",
          "type": "int",
          "location": "path",
          "description": "The ID of the alert you would like to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "alerts_get",
      "description": "**This endpoint allows you to retrieve a specific alert.**. Required: alert_id. Returns the AlertsGetResponse.",
      "method": "GET",
      "path": "/v3/alerts/{alert_id}",
      "params": [
        {
          "name": "alert_id",
          "type": "int",
          "location": "path",
          "description": "The ID of the alert you would like to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "alerts_list",
      "description": "**This endpoint allows you to retrieve all of your alerts.**. Returns array of AlertsListItem.",
      "method": "GET",
      "path": "/v3/alerts",
      "params": []
    },
    {
      "name": "alerts_update",
      "description": "**This endpoint allows you to update an alert.**. Required: alert_id. Optional: email_to, frequency, percentage. Returns the updated AlertsUpdateResponse.",
      "method": "PATCH",
      "path": "/v3/alerts/{alert_id}",
      "params": [
        {
          "name": "alert_id",
          "type": "int",
          "location": "path",
          "description": "The ID of the alert you would like to retrieve.",
          "required": true
        },
        {
          "name": "email_to",
          "type": "string",
          "location": "body",
          "description": "The new email address you want your alert to be sent to. Example: test@example.com"
        },
        {
          "name": "frequency",
          "type": "string",
          "location": "body",
          "description": "The new frequency at which to send the stats_notification alert. Example: monthly"
        },
        {
          "name": "percentage",
          "type": "int",
          "location": "body",
          "description": "The new percentage threshold at which the usage_limit alert will be sent. Example: 90"
        }
      ]
    },
    {
      "name": "api-keys_create",
      "description": "**This endpoint allows you to create a new API Key for the user.** To create your initial SendGrid API Key, you should [use the SendGrid App](https://app.sendgrid.com/settings/api_keys). Once you have created a first key with scopes to manage additional API keys, you can use this API for all other key management. A JSON request body containing a `name` property is required when making requests to this endpoint. If the number of maximum keys, 100, is reached, a `403` status will be returned. Though the `name` field is required, it does not need to be unique. A unique API key ID will be generated for each key you create and returned in the response body. It is not necessary to pass a `scopes` field to the API when creating a key, but you should be aware that omitting the `scopes` field from your request will create a key with 'Full Access' permissions by default. See the [API Key Permissions List](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/authorization) for all available scopes. An API key's scopes can be updated after creation using the 'Update API keys' endpoint. Required: name. Optional: scopes. Returns the new ApiKeysCreateResponse.",
      "method": "POST",
      "path": "/v3/api_keys",
      "params": [
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The name you will use to describe this API Key.",
          "required": true
        },
        {
          "name": "scopes",
          "type": "array",
          "location": "body",
          "description": "The individual permissions that you are giving to this API Key."
        }
      ]
    },
    {
      "name": "api-keys_delete",
      "description": "**This endpoint allows you to revoke an existing API Key using an `api_key_id`** Authentications using a revoked API Key will fail after after some small propogation delay. If the API Key ID does not exist, a `404` status will be returned. Required: api_key_id. Destructive.",
      "method": "DELETE",
      "path": "/v3/api_keys/{api_key_id}",
      "params": [
        {
          "name": "api_key_id",
          "type": "string",
          "location": "path",
          "description": "Api key id",
          "required": true
        }
      ]
    },
    {
      "name": "api-keys_get",
      "description": "**This endpoint allows you to retrieve a single API key using an `api_key_id`.** The endpoint will return a key's name, ID, and scopes. If the API Key ID does not, exist a `404` status will be returned. See the [API Key Permissions List](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/authorization) for all available scopes. An API key's scopes can be updated after creation using the 'Update API keys' endpoint. Required: api_key_id. Returns the ApiKeysGetResponse.",
      "method": "GET",
      "path": "/v3/api_keys/{api_key_id}",
      "params": [
        {
          "name": "api_key_id",
          "type": "string",
          "location": "path",
          "description": "Api key id",
          "required": true
        }
      ]
    },
    {
      "name": "api-keys_list",
      "description": "**This endpoint allows you to retrieve all API Keys that belong to the authenticated user.** A successful response from this API will include all available API keys' names and IDs. For security reasons, there is not a way to retrieve the key itself after it's created. If you lose your API key, you must create a new one. Only the 'Create API keys' endpoint will return a key to you and only at the time of creation. An `api_key_id` can be used to update or delete the key, as well as retrieve the key's details, such as its scopes. Optional: limit. Returns the ApiKeysListResponse.",
      "method": "GET",
      "path": "/v3/api_keys",
      "params": [
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "Limit"
        }
      ]
    },
    {
      "name": "api-keys_update",
      "description": "**This endpoint allows you to update the name and scopes of a given API key.** You must pass this endpoint a JSON request body with a `name` field and a `scopes` array containing at least one scope. The `name` and `scopes` fields will be used to update the key associated with the `api_key_id` in the request URL. If you need to update a key's scopes only, pass the `name` field with the key's existing name; the `name` will not be modified. If you need to update a key's name only, use the 'Update API key name' endpoint. See the [API Key Permissions List](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/authorization) for all available scopes. Required: api_key_id, name. Optional: scopes. Returns the updated ApiKeyResponse.",
      "method": "PUT",
      "path": "/v3/api_keys/{api_key_id}",
      "params": [
        {
          "name": "api_key_id",
          "type": "string",
          "location": "path",
          "description": "Api key id",
          "required": true
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "Name",
          "required": true
        },
        {
          "name": "scopes",
          "type": "array",
          "location": "body",
          "description": "Scopes"
        }
      ]
    },
    {
      "name": "api-keys_update-name",
      "description": "**This endpoint allows you to update the name of an existing API Key.** You must pass this endpoint a JSON request body with a `name` property, which will be used to rename the key associated with the `api_key_id` passed in the URL. Required: api_key_id, name. Returns the updated ApiKeyResponse.",
      "method": "PATCH",
      "path": "/v3/api_keys/{api_key_id}",
      "params": [
        {
          "name": "api_key_id",
          "type": "string",
          "location": "path",
          "description": "Api key id",
          "required": true
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The new name of the API Key.",
          "required": true
        }
      ]
    },
    {
      "name": "asm_add-suppression-to-group",
      "description": "**This endpoint allows you to add email addresses to an unsubscribe group.** If you attempt to add suppressions to a group that has been deleted or does not exist, the suppressions will be added to the global suppressions list. Required: group_id, recipient_emails. Returns the new AsmAddSuppressionToGroupResponse.",
      "method": "POST",
      "path": "/v3/asm/groups/{group_id}/suppressions",
      "params": [
        {
          "name": "group_id",
          "type": "string",
          "location": "path",
          "description": "The id of the unsubscribe group that you are adding suppressions to.",
          "required": true
        },
        {
          "name": "recipient_emails",
          "type": "array",
          "location": "body",
          "description": "The array of email addresses to add or find.",
          "required": true
        }
      ]
    },
    {
      "name": "asm_creat-group",
      "description": "**This endpoint allows you to create a new suppression group.** To add an email address to the suppression group, [create a Suppression](https://docs.sendgrid.com/api-reference/suppressions-suppressions/add-suppressions-to-a-suppression-group). Optional: description, is_default, name. Returns the new AsmCreatGroupResponse.",
      "method": "POST",
      "path": "/v3/asm/groups",
      "params": [
        {
          "name": "description",
          "type": "string",
          "location": "body",
          "description": "A brief description of your suppression group. Required when creating a group."
        },
        {
          "name": "is_default",
          "type": "bool",
          "location": "body",
          "description": "Indicates if you would like this to be your default suppression group."
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The name of your suppression group. Required when creating a group."
        }
      ]
    },
    {
      "name": "asm_create-global-suppression",
      "description": "**This endpoint allows you to add one or more email addresses to the global suppressions group.**. Required: recipient_emails. Returns the new AsmCreateGlobalSuppressionResponse.",
      "method": "POST",
      "path": "/v3/asm/suppressions/global",
      "params": [
        {
          "name": "recipient_emails",
          "type": "array",
          "location": "body",
          "description": "The array of email addresses to add or find.",
          "required": true
        }
      ]
    },
    {
      "name": "asm_delete-global-suppression",
      "description": "**This endpoint allows you to remove an email address from the global suppressions group.** Deleting a suppression group will remove the suppression, meaning email will once again be sent to the previously suppressed addresses. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our [bypass filters](https://sendgrid.com/docs/ui/sending-email/index-suppressions/#bypass-suppressions) to deliver messages to otherwise suppressed addresses when exceptions are required. Required: email. Destructive.",
      "method": "DELETE",
      "path": "/v3/asm/suppressions/global/{email}",
      "params": [
        {
          "name": "email",
          "type": "string",
          "location": "path",
          "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 suppressions list, enter that email address here.",
          "required": true
        }
      ]
    },
    {
      "name": "asm_delete-group",
      "description": "**This endpoint allows you to delete a suppression group.** If a recipient uses the 'one-click unsubscribe' option on an email associated with a deleted group, that recipient will be added to the global suppression list. Deleting a suppression group will remove the suppression, meaning email will once again be sent to the previously suppressed addresses. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our [bypass filters](https://sendgrid.com/docs/ui/sending-email/index-suppressions/#bypass-suppressions) to deliver messages to otherwise suppressed addresses when exceptions are required. Required: group_id. Destructive.",
      "method": "DELETE",
      "path": "/v3/asm/groups/{group_id}",
      "params": [
        {
          "name": "group_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the suppression group you would like to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "asm_delete-suppression-from-group",
      "description": "**This endpoint allows you to remove a suppressed email address from the given suppression group.** Removing an address will remove the suppression, meaning email will once again be sent to the previously suppressed addresses. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our [bypass filters](https://sendgrid.com/docs/ui/sending-email/index-suppressions/#bypass-suppressions) to deliver messages to otherwise suppressed addresses when exceptions are required. Required: group_id, email. Destructive.",
      "method": "DELETE",
      "path": "/v3/asm/groups/{group_id}/suppressions/{email}",
      "params": [
        {
          "name": "group_id",
          "type": "string",
          "location": "path",
          "description": "The id of the suppression group that you are removing an email address from.",
          "required": true
        },
        {
          "name": "email",
          "type": "string",
          "location": "path",
          "description": "The email address that you want to remove from the suppression group.",
          "required": true
        }
      ]
    },
    {
      "name": "asm_get-global-suppression",
      "description": "**This endpoint allows you to retrieve a global suppression. You can also use this endpoint to confirm if an email address is already globally suppresed.** If the email address you include in the URL path parameter `{email}` is already globally suppressed, the response will include that email address. If the address you enter for `{email}` is not globally suppressed, an empty JSON object `{}` will be returned. Required: email. Returns the RetrieveAGlobalSuppressionResponse.",
      "method": "GET",
      "path": "/v3/asm/suppressions/global/{email}",
      "params": [
        {
          "name": "email",
          "type": "string",
          "location": "path",
          "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 suppressions list, enter that email address here.",
          "required": true
        }
      ]
    },
    {
      "name": "asm_get-group",
      "description": "**This endpoint allows you to retrieve a single suppression group.**. Required: group_id. Returns the AsmGetGroupResponse.",
      "method": "GET",
      "path": "/v3/asm/groups/{group_id}",
      "params": [
        {
          "name": "group_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the suppression group you would like to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "asm_get-suppression",
      "description": "**This endpoint returns a list of all groups from which the given email address has been unsubscribed.**. Required: email.",
      "method": "GET",
      "path": "/v3/asm/suppressions/{email}",
      "params": [
        {
          "name": "email",
          "type": "string",
          "location": "path",
          "description": "The email address that you want to search suppression groups for.",
          "required": true
        }
      ]
    },
    {
      "name": "asm_list-group",
      "description": "**This endpoint allows you to retrieve a list of all suppression groups created by this user.** This endpoint can also return information for multiple group IDs that you include in your request. To add a group ID to your request, simply append `?id=123456\u0026id=123456`, with the appropriate group IDs. Optional: id. Returns array of SuppressionGroup.",
      "method": "GET",
      "path": "/v3/asm/groups",
      "params": [
        {
          "name": "id",
          "type": "int",
          "location": "query",
          "description": "The ID of the suppression group(s) you want to retrieve."
        }
      ]
    },
    {
      "name": "asm_list-suppression",
      "description": "**This endpoint allows you to retrieve a list of all suppressions.**. Returns array of AsmListSuppressionItem.",
      "method": "GET",
      "path": "/v3/asm/suppressions",
      "params": []
    },
    {
      "name": "asm_list-suppression-from-group",
      "description": "**This endpoint allows you to retrieve all suppressed email addresses belonging to the given group.**. Required: group_id. Returns array of string.",
      "method": "GET",
      "path": "/v3/asm/groups/{group_id}/suppressions",
      "params": [
        {
          "name": "group_id",
          "type": "string",
          "location": "path",
          "description": "The id of the unsubscribe group that you are adding suppressions to.",
          "required": true
        }
      ]
    },
    {
      "name": "asm_search-suppression-from-group",
      "description": "**This endpoint allows you to search a suppression group for multiple suppressions.** When given a list of email addresses and a group ID, this endpoint will only return the email addresses that have been unsubscribed from the given group. Required: group_id, recipient_emails. Returns array of string.",
      "method": "POST",
      "path": "/v3/asm/groups/{group_id}/suppressions/search",
      "params": [
        {
          "name": "group_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the suppression group that you would like to search.",
          "required": true
        },
        {
          "name": "recipient_emails",
          "type": "array",
          "location": "body",
          "description": "The array of email addresses to add or find.",
          "required": true
        }
      ]
    },
    {
      "name": "asm_update-group",
      "description": "**This endpoint allows you to update or change a suppression group.**. Required: group_id. Optional: description, is_default, name. Returns the updated SuppressionGroup.",
      "method": "PATCH",
      "path": "/v3/asm/groups/{group_id}",
      "params": [
        {
          "name": "group_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the suppression group you would like to retrieve.",
          "required": true
        },
        {
          "name": "description",
          "type": "string",
          "location": "body",
          "description": "A brief description of your suppression group. Required when creating a group."
        },
        {
          "name": "is_default",
          "type": "bool",
          "location": "body",
          "description": "Indicates if you would like this to be your default suppression group."
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The name of your suppression group. Required when creating a group."
        }
      ]
    },
    {
      "name": "browsers_list-stat",
      "description": "**This endpoint allows you to retrieve your email statistics segmented by browser type.** **We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [Statistics Overview](https://sendgrid.com/docs/ui/analytics-and-reporting/stats-overview/). Required: start_date. Optional: browsers, limit, offset (plus 2 more). Returns array of BrowsersListStatItem.",
      "method": "GET",
      "path": "/v3/browsers/stats",
      "params": [
        {
          "name": "browsers",
          "type": "string",
          "location": "query",
          "description": "The browsers to get statistics for. You can include up to 10 different browsers by including this parameter multiple times."
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "The number of results to return."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The point in the list to begin retrieving results."
        },
        {
          "name": "aggregated_by",
          "type": "string",
          "location": "query",
          "description": "How to group the statistics. Must be either 'day', 'week', or 'month'."
        },
        {
          "name": "start_date",
          "type": "string",
          "location": "query",
          "description": "The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.",
          "required": true
        },
        {
          "name": "end_date",
          "type": "string",
          "location": "query",
          "description": "The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."
        }
      ]
    },
    {
      "name": "campaigns_create",
      "description": "**This endpoint allows you to create a campaign.** In order to send or schedule the campaign, you will be required to provide a subject, sender ID, content (we suggest both html and plain text), and at least one list or segment ID. This information is not required when you create a campaign. Required: title. Optional: categories, custom_unsubscribe_url, editor (plus 8 more). Returns the new Campaigns2xx.",
      "method": "POST",
      "path": "/v3/campaigns",
      "params": [
        {
          "name": "categories",
          "type": "array",
          "location": "body",
          "description": "The categories you would like associated to this campaign."
        },
        {
          "name": "custom_unsubscribe_url",
          "type": "string",
          "location": "body",
          "description": "This is the url of the custom unsubscribe page that you provide for customers to unsubscribe from your suppression groups."
        },
        {
          "name": "editor",
          "type": "string",
          "location": "body",
          "description": "The editor used in the UI."
        },
        {
          "name": "html_content",
          "type": "string",
          "location": "body",
          "description": "The HTML of your marketing email."
        },
        {
          "name": "ip_pool",
          "type": "string",
          "location": "body",
          "description": "The pool of IPs that you would like to send this email from."
        },
        {
          "name": "list_ids",
          "type": "array",
          "location": "body",
          "description": "The IDs of the lists you are sending this campaign to. You can have both segment IDs and list IDs"
        },
        {
          "name": "plain_content",
          "type": "string",
          "location": "body",
          "description": "The plain text content of your emails."
        },
        {
          "name": "segment_ids",
          "type": "array",
          "location": "body",
          "description": "The segment IDs that you are sending this list to. You can have both segment IDs and list IDs. Segments are limited to 10 segment IDs."
        },
        {
          "name": "sender_id",
          "type": "int",
          "location": "body",
          "description": "The ID of the 'sender' identity that you have created. Your recipients will see this as the 'from' on your marketing emails."
        },
        {
          "name": "subject",
          "type": "string",
          "location": "body",
          "description": "The subject of your campaign that your recipients will see."
        },
        {
          "name": "suppression_group_id",
          "type": "int",
          "location": "body",
          "description": "The suppression group that this marketing email belongs to, allowing recipients to opt-out of emails of this type."
        },
        {
          "name": "title",
          "type": "string",
          "location": "body",
          "description": "The display title of your campaign. This will be viewable by you in the Marketing Campaigns UI.",
          "required": true
        }
      ]
    },
    {
      "name": "campaigns_delete",
      "description": "**This endpoint allows you to delete a specific campaign.**. Required: campaign_id. Destructive.",
      "method": "DELETE",
      "path": "/v3/campaigns/{campaign_id}",
      "params": [
        {
          "name": "campaign_id",
          "type": "int",
          "location": "path",
          "description": "The id of the campaign you would like to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "campaigns_get",
      "description": "**This endpoint allows you to retrieve a specific campaign.**. Required: campaign_id. Returns the CampaignsGetResponse.",
      "method": "GET",
      "path": "/v3/campaigns/{campaign_id}",
      "params": [
        {
          "name": "campaign_id",
          "type": "int",
          "location": "path",
          "description": "The id of the campaign you would like to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "campaigns_list",
      "description": "**This endpoint allows you to retrieve a paginated list of all of your campaigns.** Returns campaigns in reverse order they were created (newest first). Returns an empty array if no campaigns exist. You can use the `limit` query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the `offset` query parameter to control the position in the list from which to start retrieving additional items. Optional: limit (default: 10), offset (default: 0).",
      "method": "GET",
      "path": "/v3/campaigns",
      "params": [
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "`limit` sets the page size, i."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The number of items in the list to skip over before starting to retrieve the items for the..."
        }
      ]
    },
    {
      "name": "campaigns_update",
      "description": "**This endpoint allows you to update a specific campaign.** This is especially useful if you only set up the campaign using POST /campaigns, but didn't set many of the parameters. Required: campaign_id, categories, html_content, plain_content, subject, title. Returns the updated Campaigns2xx.",
      "method": "PATCH",
      "path": "/v3/campaigns/{campaign_id}",
      "params": [
        {
          "name": "campaign_id",
          "type": "int",
          "location": "path",
          "description": "The id of the campaign you would like to retrieve.",
          "required": true
        },
        {
          "name": "categories",
          "type": "array",
          "location": "body",
          "description": "The categories you want to tag on this campaign.",
          "required": true
        },
        {
          "name": "html_content",
          "type": "string",
          "location": "body",
          "description": "The HTML content of this campaign.",
          "required": true
        },
        {
          "name": "plain_content",
          "type": "string",
          "location": "body",
          "description": "The plain content of this campaign.",
          "required": true
        },
        {
          "name": "subject",
          "type": "string",
          "location": "body",
          "description": "The subject line for your campaign.",
          "required": true
        },
        {
          "name": "title",
          "type": "string",
          "location": "body",
          "description": "The title of the campaign.",
          "required": true
        }
      ]
    },
    {
      "name": "campaigns_schedules_campaign",
      "description": "**This endpoint allows you to schedule a specific date and time for your campaign to be sent.** If you have the flexibility, it's better to schedule mail for off-peak times. Most emails are scheduled and sent at the top of the hour or half hour. Scheduling email to avoid those times (for example, scheduling at 10:53) can result in lower deferral rates because it won't be going through our servers at the same times as everyone else's mail. Required: campaign_id, send_at. Returns the new ScheduleACampaignResponse.",
      "method": "POST",
      "path": "/v3/campaigns/{campaign_id}/schedules",
      "params": [
        {
          "name": "campaign_id",
          "type": "int",
          "location": "path",
          "description": "Campaign id",
          "required": true
        },
        {
          "name": "send_at",
          "type": "int",
          "location": "body",
          "description": "The unix timestamp for the date and time you would like your campaign to be sent out.",
          "required": true
        }
      ]
    },
    {
      "name": "campaigns_schedules_get-scheduled-campaign",
      "description": "**This endpoint allows you to retrieve the date and time that a campaign has been scheduled to be sent.**. Required: campaign_id. Returns the ViewScheduledTimeOfACampaignResponse.",
      "method": "GET",
      "path": "/v3/campaigns/{campaign_id}/schedules",
      "params": [
        {
          "name": "campaign_id",
          "type": "int",
          "location": "path",
          "description": "Campaign id",
          "required": true
        }
      ]
    },
    {
      "name": "campaigns_schedules_send-campaign",
      "description": "**This endpoint allows you to immediately send an existing campaign.** Normally a POST request would have a body, but since this endpoint is telling us to send a resource that is already created, a request body is not needed. Required: campaign_id. Returns the new SendACampaignResponse.",
      "method": "POST",
      "path": "/v3/campaigns/{campaign_id}/schedules/now",
      "params": [
        {
          "name": "campaign_id",
          "type": "int",
          "location": "path",
          "description": "Campaign id",
          "required": true
        }
      ]
    },
    {
      "name": "campaigns_schedules_send-test-campaign",
      "description": "**This endpoint allows you to send a test campaign.** To send to multiple addresses, use an array for the JSON 'to' value ['one@address','two@address']. Required: campaign_id, to. Returns the new SendATestCampaignRequest.",
      "method": "POST",
      "path": "/v3/campaigns/{campaign_id}/schedules/test",
      "params": [
        {
          "name": "campaign_id",
          "type": "int",
          "location": "path",
          "description": "Campaign id",
          "required": true
        },
        {
          "name": "to",
          "type": "string",
          "location": "body",
          "description": "The email address that should receive the test campaign.",
          "required": true
        }
      ]
    },
    {
      "name": "campaigns_schedules_un-campaign",
      "description": "**This endpoint allows you to unschedule a campaign that has already been scheduled to be sent.** A successful unschedule will return a 204. If the specified campaign is in the process of being sent, the only option is to cancel (a different method). Required: campaign_id. Destructive.",
      "method": "DELETE",
      "path": "/v3/campaigns/{campaign_id}/schedules",
      "params": [
        {
          "name": "campaign_id",
          "type": "int",
          "location": "path",
          "description": "Campaign id",
          "required": true
        }
      ]
    },
    {
      "name": "campaigns_schedules_update-scheduled-campaign",
      "description": "**This endpoint allows to you change the scheduled time and date for a campaign to be sent.**. Required: campaign_id, send_at. Returns the updated UpdateAScheduledCampaignResponse.",
      "method": "PATCH",
      "path": "/v3/campaigns/{campaign_id}/schedules",
      "params": [
        {
          "name": "campaign_id",
          "type": "int",
          "location": "path",
          "description": "Campaign id",
          "required": true
        },
        {
          "name": "send_at",
          "type": "int",
          "location": "body",
          "description": "Send at",
          "required": true
        }
      ]
    },
    {
      "name": "categories_list-category",
      "description": "**This endpoint allows you to retrieve a paginated list of all of your categories.** You can use the `limit` query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the `offset` query parameter to control the position in the list from which to start retrieving additional items. Optional: limit (default: 50), category, offset (default: 0). Returns array of CategoriesListCategoryItem.",
      "method": "GET",
      "path": "/v3/categories",
      "params": [
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "`limit` sets the page size, i."
        },
        {
          "name": "category",
          "type": "string",
          "location": "query",
          "description": "Allows you to perform a prefix search on this particular category."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The number of items in the list to skip over before starting to retrieve the items for the..."
        }
      ]
    },
    {
      "name": "categories_list-category-stat",
      "description": "**This endpoint allows you to retrieve all of your email statistics for each of your categories.** If you do not define any query parameters, this endpoint will return a sum for each category in groups of 10. Required: start_date, categories. Optional: end_date, aggregated_by. Returns array of CategoryStats.",
      "method": "GET",
      "path": "/v3/categories/stats",
      "params": [
        {
          "name": "start_date",
          "type": "string",
          "location": "query",
          "description": "The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD",
          "required": true
        },
        {
          "name": "end_date",
          "type": "string",
          "location": "query",
          "description": "The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."
        },
        {
          "name": "categories",
          "type": "string",
          "location": "query",
          "description": "The individual categories that you want to retrieve statistics for. You may include up to 10 different categories.",
          "required": true
        },
        {
          "name": "aggregated_by",
          "type": "string",
          "location": "query",
          "description": "How to group the statistics. Must be either 'day', 'week', or 'month'."
        }
      ]
    },
    {
      "name": "categories_list-category-stat-sum",
      "description": "**This endpoint allows you to retrieve the total sum of each email statistic for every category over the given date range.** If you do not define any query parameters, this endpoint will return a sum for each category in groups of 10. Required: start_date. Optional: sort_by_metric (default: delivered), sort_by_direction (default: desc), end_date (plus 3 more). Returns the CategoryStats.",
      "method": "GET",
      "path": "/v3/categories/stats/sums",
      "params": [
        {
          "name": "sort_by_metric",
          "type": "string",
          "location": "query",
          "description": "The metric that you want to sort by. Must be a single metric."
        },
        {
          "name": "sort_by_direction",
          "type": "string",
          "location": "query",
          "description": "The direction you want to sort."
        },
        {
          "name": "start_date",
          "type": "string",
          "location": "query",
          "description": "The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.",
          "required": true
        },
        {
          "name": "end_date",
          "type": "string",
          "location": "query",
          "description": "The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "Limits the number of results returned."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The point in the list to begin retrieving results."
        },
        {
          "name": "aggregated_by",
          "type": "string",
          "location": "query",
          "description": "How to group the statistics. Must be either 'day', 'week', or 'month'."
        }
      ]
    },
    {
      "name": "clients_list-stat",
      "description": "**This endpoint allows you to retrieve your email statistics segmented by client type.** **We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [Statistics Overview](https://sendgrid.com/docs/ui/analytics-and-reporting/stats-overview/). Required: start_date. Optional: end_date, aggregated_by. Returns array of ClientsListStatItem.",
      "method": "GET",
      "path": "/v3/clients/stats",
      "params": [
        {
          "name": "start_date",
          "type": "string",
          "location": "query",
          "description": "The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.",
          "required": true
        },
        {
          "name": "end_date",
          "type": "string",
          "location": "query",
          "description": "The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."
        },
        {
          "name": "aggregated_by",
          "type": "string",
          "location": "query",
          "description": "How to group the statistics. Must be either 'day', 'week', or 'month'."
        }
      ]
    },
    {
      "name": "clients_stats_get-client",
      "description": "**This endpoint allows you to retrieve your email statistics segmented by a specific client type.** **We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. ### Available Client Types - phone - tablet - webmail - desktop Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [Statistics Overview](https://sendgrid.com/docs/ui/analytics-and-reporting/stats-overview/). Required: client_type (default: phone), start_date. Optional: end_date, aggregated_by. Returns array of StatsGetClientItem.",
      "method": "GET",
      "path": "/v3/clients/{client_type}/stats",
      "params": [
        {
          "name": "client_type",
          "type": "string",
          "location": "path",
          "description": "Specifies the type of client to retrieve stats for. Must be either 'phone', 'tablet', 'webmail', or 'desktop'."
        },
        {
          "name": "start_date",
          "type": "string",
          "location": "query",
          "description": "The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.",
          "required": true
        },
        {
          "name": "end_date",
          "type": "string",
          "location": "query",
          "description": "The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."
        },
        {
          "name": "aggregated_by",
          "type": "string",
          "location": "query",
          "description": "How to group the statistics. Must be either 'day', 'week', or 'month'."
        }
      ]
    },
    {
      "name": "contactdb_add-recipient",
      "description": "**This endpoint allows you to add a Marketing Campaigns recipient.** You can add custom field data as a parameter on this endpoint. We have provided an example using some of the default custom fields SendGrid provides. The rate limit is three requests every 2 seconds. You can upload 1000 contacts per request. So the maximum upload rate is 1500 recipients per second. Returns the new ContactdbRecipientResponse201.",
      "method": "POST",
      "path": "/v3/contactdb/recipients",
      "params": []
    },
    {
      "name": "contactdb_add-recipient-to-contact-db-list",
      "description": "**This endpoint allows you to add a single recipient to a list.**. Required: list_id, recipient_id.",
      "method": "POST",
      "path": "/v3/contactdb/lists/{list_id}/recipients/{recipient_id}",
      "params": [
        {
          "name": "list_id",
          "type": "int",
          "location": "path",
          "description": "The ID of the list that you want to add the recipient to.",
          "required": true
        },
        {
          "name": "recipient_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the recipient you are adding to the list.",
          "required": true
        }
      ]
    },
    {
      "name": "contactdb_add-recipients-to-contact-db-list",
      "description": "**This endpoint allows you to add multiple recipients to a list.** Adds existing recipients to a list, passing in the recipient IDs to add. Recipient IDs (base64-encoded email addresses) should be passed exactly as they are returned from recipient endpoints. Required: list_id.",
      "method": "POST",
      "path": "/v3/contactdb/lists/{list_id}/recipients",
      "params": [
        {
          "name": "list_id",
          "type": "int",
          "location": "path",
          "description": "The id of the list of recipients you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "contactdb_create-contact-db-list",
      "description": "**This endpoint allows you to create a list for your recipients.**. Required: name. Returns the new ContactdbList2xx.",
      "method": "POST",
      "path": "/v3/contactdb/lists",
      "params": [
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "Name",
          "required": true
        }
      ]
    },
    {
      "name": "contactdb_create-custom-field",
      "description": "**This endpoint allows you to create a custom field.** **You can create up to 120 custom fields.**. Optional: name, type. Returns the new ContactdbCustomFieldId2xx.",
      "method": "POST",
      "path": "/v3/contactdb/custom_fields",
      "params": [
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "Name"
        },
        {
          "name": "type",
          "type": "string",
          "location": "body",
          "description": "Type"
        }
      ]
    },
    {
      "name": "contactdb_create-segment",
      "description": "**This endpoint allows you to create a new segment.** Valid operators for create and update depend on the type of the field for which you are searching. **Dates** - 'eq', 'ne', 'lt' (before), 'gt' (after) - You may use MM/DD/YYYY for day granularity or an epoch for second granularity. - 'empty', 'not_empty' - 'is within' - You may use an [ISO 8601 date format](https://en.wikipedia.org/wiki/ISO_8601) or the # of days. **Text** - 'contains' - 'eq' (is/equals - matches the full field) - 'ne' (is not/not equals - matches any field where the entire field is not the condition value) - 'empty' - 'not_empty' **Numbers** - 'eq' (is/equals) - 'lt' (is less than) - 'gt' (is greater than) - 'empty' - 'not_empty' **Email Clicks and Opens** - 'eq' (opened) - 'ne' (not opened) All field values must be a string. Conditions using 'eq' or 'ne' for email clicks and opens should provide a 'field' of either `clicks.campaign_identifier` or `opens.campaign_identifier`. The condition value should be a string containing the id of a completed campaign. The conditions list may contain multiple conditions, joined by an 'and' or 'or' in the 'and_or' field. The first condition in the conditions list must have an empty 'and_or', and subsequent conditions must all specify an 'and_or'. Required: conditions, name. Optional: list_id, recipient_count. Returns the new ContactdbSegmentsId200.",
      "method": "POST",
      "path": "/v3/contactdb/segments",
      "params": [
        {
          "name": "conditions",
          "type": "array",
          "location": "body",
          "description": "The conditions for a recipient to be included in this segment.",
          "required": true
        },
        {
          "name": "list_id",
          "type": "int",
          "location": "body",
          "description": "The list id from which to make this segment. Not including this ID will mean your segment is created from the main contactdb rather than a list."
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The name of this segment.",
          "required": true
        },
        {
          "name": "recipient_count",
          "type": "float",
          "location": "body",
          "description": "The count of recipients in this list. This is not included on creation of segments."
        }
      ]
    },
    {
      "name": "contactdb_delete-contact-db-list",
      "description": "**This endpoint allows you to delete a specific recipient list with the given ID.**. Required: list_id. Optional: delete_contacts. Destructive.",
      "method": "DELETE",
      "path": "/v3/contactdb/lists/{list_id}",
      "params": [
        {
          "name": "list_id",
          "type": "int",
          "location": "path",
          "description": "List id",
          "required": true
        },
        {
          "name": "delete_contacts",
          "type": "bool",
          "location": "query",
          "description": "Adds the ability to delete all contacts on the list in addition to deleting the list."
        }
      ]
    },
    {
      "name": "contactdb_delete-contact-db-lists",
      "description": "**This endpoint allows you to delete multiple recipient lists.**. Destructive.",
      "method": "DELETE",
      "path": "/v3/contactdb/lists",
      "params": []
    },
    {
      "name": "contactdb_delete-custom-field",
      "description": "**This endpoint allows you to delete a custom field by ID.**. Required: custom_field_id. Returns the ErrorResponse. Destructive.",
      "method": "DELETE",
      "path": "/v3/contactdb/custom_fields/{custom_field_id}",
      "params": [
        {
          "name": "custom_field_id",
          "type": "int",
          "location": "path",
          "description": "The ID of the custom field that you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "contactdb_delete-recipient",
      "description": "**This endpoint allows you to delete a single recipient with the given ID from your contact database.** \u003e Use this to permanently delete your recipients from all of your contact lists and all segments if required by applicable law. Required: recipient_id. Destructive.",
      "method": "DELETE",
      "path": "/v3/contactdb/recipients/{recipient_id}",
      "params": [
        {
          "name": "recipient_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the recipient that you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "contactdb_delete-recipient-from-contact-db-list",
      "description": "**This endpoint allows you to delete a single recipient from a list.**. Required: list_id, recipient_id. Destructive.",
      "method": "DELETE",
      "path": "/v3/contactdb/lists/{list_id}/recipients/{recipient_id}",
      "params": [
        {
          "name": "list_id",
          "type": "int",
          "location": "path",
          "description": "The ID of the list that you want to add the recipient to.",
          "required": true
        },
        {
          "name": "recipient_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the recipient you are adding to the list.",
          "required": true
        }
      ]
    },
    {
      "name": "contactdb_delete-recipients",
      "description": "**This endpoint allows you to deletes one or more recipients.** The body of an API call to this endpoint must include an array of recipient IDs of the recipients you want to delete. Returns the ContactdbDeleteRecipientsResponse. Destructive.",
      "method": "DELETE",
      "path": "/v3/contactdb/recipients",
      "params": []
    },
    {
      "name": "contactdb_delete-segment",
      "description": "**This endpoint allows you to delete a segment from your recipients database.** You also have the option to delete all the contacts from your Marketing Campaigns recipient database who were in this segment. Required: segment_id. Optional: delete_contacts. Destructive.",
      "method": "DELETE",
      "path": "/v3/contactdb/segments/{segment_id}",
      "params": [
        {
          "name": "segment_id",
          "type": "int",
          "location": "path",
          "description": "Segment id",
          "required": true
        },
        {
          "name": "delete_contacts",
          "type": "bool",
          "location": "query",
          "description": "True to delete all contacts matching the segment in addition to deleting the segment"
        }
      ]
    },
    {
      "name": "contactdb_export-recipient",
      "description": "**Use this endpoint to export lists or segments of recipients**. If you would just like to have a link to the exported list sent to your email set the `notifications.email` option to `true` in the `POST` payload. If you would like to download the list, take the `id` that is returned and use the 'Export Recipients Status' endpoint to get the `urls`. Once you have the list of URLs, make a `GET` request to each URL provided to download your CSV file(s). You specify the segments and or/recipient lists you wish to export by providing the relevant IDs in, respectively, the `segment_ids` and `list_ids` fields in the request body. The lists will be provided in either JSON or CSV files. To specify which of these you would required, set the request body `file_type` field to `json` or `csv`. You can also specify a maximum file size (in MB). If the export file is larger than this, it will be split into multiple files. Optional: file_type (default: csv), list_ids, max_file_size (default: 5000) (plus 2 more). Returns the new ContactdbExportRecipientResponse.",
      "method": "POST",
      "path": "/v3/contactdb/exports",
      "params": [
        {
          "name": "file_type",
          "type": "string",
          "location": "body",
          "description": "File type for export file. Choose from `json` or `csv`."
        },
        {
          "name": "list_ids",
          "type": "array",
          "location": "body",
          "description": "IDs of the recipient lists you want to export."
        },
        {
          "name": "max_file_size",
          "type": "int",
          "location": "body",
          "description": "The maximum size of an export file in MB. Note that when this option is specified, multiple output files may be returned from the export."
        },
        {
          "name": "notifications",
          "type": "object",
          "location": "body",
          "description": "Notifications"
        },
        {
          "name": "segment_ids",
          "type": "array",
          "location": "body",
          "description": "IDs of the recipient segments you want to export."
        }
      ]
    },
    {
      "name": "contactdb_get-billable",
      "description": "**This endpoint allows you to retrieve the number of Marketing Campaigns recipients that you will be billed for.** You are billed for marketing campaigns based on the highest number of recipients you have had in your account at one time. This endpoint will allow you to know the current billable count value. Returns the ContactdbRecipientCount200.",
      "method": "GET",
      "path": "/v3/contactdb/recipients/billable_count",
      "params": []
    },
    {
      "name": "contactdb_get-contact-db-list",
      "description": "**This endpoint allows you to retrieve a single recipient list.**. Required: list_id. Returns the ContactdbList2xx.",
      "method": "GET",
      "path": "/v3/contactdb/lists/{list_id}",
      "params": [
        {
          "name": "list_id",
          "type": "int",
          "location": "path",
          "description": "List id",
          "required": true
        }
      ]
    },
    {
      "name": "contactdb_get-custom-field",
      "description": "**This endpoint allows you to retrieve a custom field by ID.**. Required: custom_field_id. Returns the ContactdbCustomFieldId2xx.",
      "method": "GET",
      "path": "/v3/contactdb/custom_fields/{custom_field_id}",
      "params": [
        {
          "name": "custom_field_id",
          "type": "int",
          "location": "path",
          "description": "The ID of the custom field that you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "contactdb_get-export-recipient",
      "description": "**This endpoint can be used to check the status of a recipient export job**. To use this call, you will need the `id` from the 'Export Recipients' call. If you would like to download a list, take the `id` that is returned from the 'Export Recipients' endpoint and make an API request here to get the `urls`. Once you have the list of URLs, make a `GET` request on each URL to download your CSV file(s). Twilio SendGrid recommends exporting your recipients regularly as a backup to avoid issues or lost data. Required: id. Returns the RecipientExport.",
      "method": "GET",
      "path": "/v3/contactdb/exports/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        }
      ]
    },
    {
      "name": "contactdb_get-recipient",
      "description": "**This endpoint allows you to retrieve a single recipient by ID from your contact database.**. Required: recipient_id. Returns the ContactdbRecipient200.",
      "method": "GET",
      "path": "/v3/contactdb/recipients/{recipient_id}",
      "params": [
        {
          "name": "recipient_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the recipient that you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "contactdb_get-recipient-list",
      "description": "**This endpoint allows you to retrieve the lists that a given recipient belongs to.** Each recipient can be on many lists. This endpoint gives you all of the lists that any one recipient has been added to. Required: recipient_id. Returns the ContactdbGetRecipientListResponse.",
      "method": "GET",
      "path": "/v3/contactdb/recipients/{recipient_id}/lists",
      "params": [
        {
          "name": "recipient_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the recipient for whom you are retrieving lists.",
          "required": true
        }
      ]
    },
    {
      "name": "contactdb_get-segment",
      "description": "**This endpoint allows you to retrieve a single segment with the given ID.**. Required: segment_id. Returns the ContactdbSegments.",
      "method": "GET",
      "path": "/v3/contactdb/segments/{segment_id}",
      "params": [
        {
          "name": "segment_id",
          "type": "int",
          "location": "path",
          "description": "Segment id",
          "required": true
        }
      ]
    },
    {
      "name": "contactdb_list-contact-db-list",
      "description": "**This endpoint allows you to retrieve all of your recipient lists. If you don't have any lists, an empty array will be returned.**. Returns the ListAllListsResponse.",
      "method": "GET",
      "path": "/v3/contactdb/lists",
      "params": []
    },
    {
      "name": "contactdb_list-custom-field",
      "description": "**This endpoint allows you to retrieve all custom fields.**. Returns the ListAllCustomFieldsResponse.",
      "method": "GET",
      "path": "/v3/contactdb/custom_fields",
      "params": []
    },
    {
      "name": "contactdb_list-export-recipient",
      "description": "**Use this endpoint to retrieve details of all current exported jobs**. It will return an array of objects, each of which records an export job in flight or recently completed. Each object's `export_type` field will tell you which kind of export it is and its `status` field will indicate what stage of processing it has reached. Exports which are `ready` will be accompanied by a `urls` field which lists the URLs of the export's downloadable files — there will be more than one if you specified a maximum file size in your initial export request. Use this endpoint if you have exports in flight but do not know their IDs, which are required for the 'Export Recipients Status' endpoint. Returns the ContactdbListExportRecipientResponse.",
      "method": "GET",
      "path": "/v3/contactdb/exports",
      "params": []
    },
    {
      "name": "contactdb_list-recipient",
      "description": "**This endpoint allows you to retrieve all of your Marketing Campaigns recipients.** Batch deletion of a page makes it possible to receive an empty page of recipients before reaching the end of the list of recipients. To avoid this issue; iterate over pages until a 404 is retrieved. Optional: page, page_size. Returns the ListRecipientsResponse.",
      "method": "GET",
      "path": "/v3/contactdb/recipients",
      "params": [
        {
          "name": "page",
          "type": "int",
          "location": "query",
          "description": "Page index of first recipients to return (must be a positive integer)"
        },
        {
          "name": "page_size",
          "type": "int",
          "location": "query",
          "description": "Number of recipients to return at a time (must be a positive integer between 1 and 1000)"
        }
      ]
    },
    {
      "name": "contactdb_list-recipient-count",
      "description": "**This endpoint allows you to retrieve the total number of Marketing Campaigns recipients.**. Returns the ContactdbRecipientCount200.",
      "method": "GET",
      "path": "/v3/contactdb/recipients/count",
      "params": []
    },
    {
      "name": "contactdb_list-recipient-for-segment",
      "description": "**This endpoint allows you to retrieve all of the recipients in a segment with the given ID.**. Required: segment_id. Optional: page, page_size. Returns the ListRecipientsOnASegmentResponse.",
      "method": "GET",
      "path": "/v3/contactdb/segments/{segment_id}/recipients",
      "params": [
        {
          "name": "segment_id",
          "type": "int",
          "location": "path",
          "description": "The ID of the segment from which you want to retrieve recipients.",
          "required": true
        },
        {
          "name": "page",
          "type": "int",
          "location": "query",
          "description": "Page"
        },
        {
          "name": "page_size",
          "type": "int",
          "location": "query",
          "description": "Page size"
        }
      ]
    },
    {
      "name": "contactdb_list-recipients-from-contact-db-list",
      "description": "**This endpoint allows you to retrieve all recipients on the list with the given ID.**. Required: list_id. Optional: page, page_size. Returns the ContactdbListRecipientsFromContactDbListResponse.",
      "method": "GET",
      "path": "/v3/contactdb/lists/{list_id}/recipients",
      "params": [
        {
          "name": "list_id",
          "type": "int",
          "location": "path",
          "description": "The id of the list of recipients you want to retrieve.",
          "required": true
        },
        {
          "name": "page",
          "type": "int",
          "location": "query",
          "description": "Page index of first recipient to return (must be a positive integer)"
        },
        {
          "name": "page_size",
          "type": "int",
          "location": "query",
          "description": "Number of recipients to return at a time (must be a positive integer between 1 and 1000)"
        }
      ]
    },
    {
      "name": "contactdb_list-reserved-field",
      "description": "**This endpoint allows you to list all fields that are reserved and can't be used for custom field names.**. Returns the ContactdbListReservedFieldResponse.",
      "method": "GET",
      "path": "/v3/contactdb/reserved_fields",
      "params": []
    },
    {
      "name": "contactdb_list-search-recipient",
      "description": "**This endpoint allows you to perform a search on all of your Marketing Campaigns recipients.** field_name: * is a variable that is substituted for your actual custom field name from your recipient. * Text fields must be url-encoded. Date fields are searchable only by unix timestamp (e.g. 2/2/2015 becomes 1422835200) * If field_name is a 'reserved' date field, such as created_at or updated_at, the system will internally convert your epoch time to a date range encompassing the entire day. For example, an epoch time of 1422835600 converts to Mon, 02 Feb 2015 00:06:40 GMT, but internally the system will search from Mon, 02 Feb 2015 00:00:00 GMT through Mon, 02 Feb 2015 23:59:59 GMT. Optional: {field_name}. Returns the ContactdbListSearchRecipientResponse.",
      "method": "GET",
      "path": "/v3/contactdb/recipients/search",
      "params": [
        {
          "name": "{field_name}",
          "type": "string",
          "location": "query",
          "description": "Field name"
        }
      ]
    },
    {
      "name": "contactdb_list-segment",
      "description": "**This endpoint allows you to retrieve all of your segments.**. Returns the ListAllSegmentsResponse.",
      "method": "GET",
      "path": "/v3/contactdb/segments",
      "params": []
    },
    {
      "name": "contactdb_list-status",
      "description": "**This endpoint allows you to check the upload status of a Marketing Campaigns recipient.**. Returns the ContactdbListStatusResponse.",
      "method": "GET",
      "path": "/v3/contactdb/status",
      "params": []
    },
    {
      "name": "contactdb_search-recipient",
      "description": "Search using segment conditions without actually creating a segment. Body contains a JSON object with `conditions`, a list of conditions as described below, and an optional `list_id`, which is a valid list ID for a list to limit the search on. Valid operators for create and update depend on the type of the field for which you are searching. - Dates: - `'eq'`, `'ne'`, `'lt'` (before), `'gt'` (after) - You may use MM/DD/YYYY for day granularity or an epoch for second granularity. - `'empty'`, `'not_empty'` - `'is within'` - You may use an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date format or the # of days. - Text: `'contains'`, `'eq'` (is - matches the full field), `'ne'` (is not - matches any field where the entire field is not the condition value), `'empty'`, `'not_empty'` - Numbers: `'eq'`, `'lt'`, `'gt'`, `'empty'`, `'not_empty'` - Email Clicks and Opens: `'eq'` (opened), `'ne'` (not opened) Field values must all be a string. Search conditions using `'eq'` or `'ne'` for email clicks and opens should provide a 'field' of either `clicks.campaign_identifier` or `opens.campaign_identifier`. The condition value should be a string containing the id of a completed campaign. Search conditions list may contain multiple conditions, joined by an `'and'` or `'or'` in the `'and_or'` field. The first condition in the conditions list must have an empty `'and_or'`, and subsequent conditions must all specify an `'and_or'`. Required: conditions, list_id. Returns the new ContactdbSearchRecipientResponse.",
      "method": "POST",
      "path": "/v3/contactdb/recipients/search",
      "params": [
        {
          "name": "conditions",
          "type": "array",
          "location": "body",
          "description": "The conditions by which this segment should be created.",
          "required": true
        },
        {
          "name": "list_id",
          "type": "int",
          "location": "body",
          "description": "List id",
          "required": true
        }
      ]
    },
    {
      "name": "contactdb_update-contact-db-list",
      "description": "**This endpoint allows you to update the name of one of your recipient lists.**. Required: list_id, name. Returns the updated ContactdbUpdateContactDbListResponse.",
      "method": "PATCH",
      "path": "/v3/contactdb/lists/{list_id}",
      "params": [
        {
          "name": "list_id",
          "type": "int",
          "location": "path",
          "description": "List id",
          "required": true
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The new name for your list.",
          "required": true
        }
      ]
    },
    {
      "name": "contactdb_update-recipient",
      "description": "**This endpoint allows you to update one or more recipients.** The body of an API call to this endpoint must include an array of one or more recipient objects. It is of note that you can add custom field data as parameters on recipient objects. We have provided an example using some of the default custom fields SendGrid provides. Returns the updated ContactdbRecipientResponse201.",
      "method": "PATCH",
      "path": "/v3/contactdb/recipients",
      "params": []
    },
    {
      "name": "contactdb_update-segment",
      "description": "**This endpoint allows you to update a segment.**. Required: segment_id, name. Optional: conditions, list_id. Returns the updated ContactdbSegments.",
      "method": "PATCH",
      "path": "/v3/contactdb/segments/{segment_id}",
      "params": [
        {
          "name": "segment_id",
          "type": "int",
          "location": "path",
          "description": "Segment id",
          "required": true
        },
        {
          "name": "conditions",
          "type": "array",
          "location": "body",
          "description": "The conditions by which this segment should be created."
        },
        {
          "name": "list_id",
          "type": "float",
          "location": "body",
          "description": "The list ID you would like this segment to be built from."
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "Name",
          "required": true
        }
      ]
    },
    {
      "name": "designs_create",
      "description": "**This endpoint allows you to create a new design**. You can add a new design by passing data, including a string of HTML email content, to `/designs`. When creating designs from scratch, be aware of the styling constraints inherent to many email clients. For a list of best practices, see our guide to [Cross-Platform Email Design](https://sendgrid.com/docs/ui/sending-email/cross-platform-html-design/). The Design Library can also convert your design’s HTML elements into drag and drop modules that are editable in the Designs Library user interface. For more, visit the [Design and Code Editor documentation](https://sendgrid.com/docs/ui/sending-email/editor/#drag--drop-markup). Because the `/designs` endpoint makes it easy to add designs, you can create a design with your preferred tooling or migrate designs you already own without relying on the Design Library UI. Required: html_content. Optional: editor, name, plain_content. Returns the new DesignOutput.",
      "method": "POST",
      "path": "/v3/designs",
      "params": [
        {
          "name": "editor",
          "type": "string",
          "location": "body",
          "description": "The editor used in the UI."
        },
        {
          "name": "html_content",
          "type": "string",
          "location": "body",
          "description": "The HTML content of the Design.",
          "required": true
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The name of the new design."
        },
        {
          "name": "plain_content",
          "type": "string",
          "location": "body",
          "description": "Plain text content of the Design."
        }
      ]
    },
    {
      "name": "designs_delete",
      "description": "**This endpoint allows you to delete a single design**. Be sure to check the ID of the design you intend to delete before making this request; deleting a design is a permanent action. Required: id. Destructive.",
      "method": "DELETE",
      "path": "/v3/designs/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the Design you want to duplicate.",
          "required": true
        }
      ]
    },
    {
      "name": "designs_duplicate",
      "description": "**This endpoint allows you to duplicate one of your existing designs**. Modifying an existing design is often the easiest way to create something new. You are not required to pass any data in the body of a request to this endpoint. If you choose to leave the `name` field blank, your duplicate will be assigned the name of the design it was copied from with the text 'Duplicate: ' prepended to it. This name change is only a convenience, as the duplicate will be assigned a unique ID that differentiates it from your other designs. You can modify your duplicate’s name at the time of creation by passing an updated value to the `name` field when making the initial request. More on retrieving design IDs can be found below. Required: id. Optional: editor, name. Returns the new DesignOutput.",
      "method": "POST",
      "path": "/v3/designs/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the Design you want to duplicate.",
          "required": true
        },
        {
          "name": "editor",
          "type": "string",
          "location": "body",
          "description": "The editor used in the UI."
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The name of the new design."
        }
      ]
    },
    {
      "name": "designs_duplicate-pre-built",
      "description": "**This endpoint allows you to duplicate one of the pre-built Twilio SendGrid designs**. Like duplicating one of your existing designs, you are not required to pass any data in the body of a request to this endpoint. If you choose to leave the `name` field blank, your duplicate will be assigned the name of the design it was copied from with the text 'Duplicate: ' prepended to it. This name change is only a convenience, as the duplicate design will be assigned a unique ID that differentiates it from your other designs. You can retrieve the IDs for Twilio SendGrid pre-built designs using the 'List SendGrid Pre-built Designs' endpoint. You can modify your duplicate’s name at the time of creation by passing an updated value to the `name` field when making the initial request. More on retrieving design IDs can be found above. Required: id. Optional: editor, name. Returns the new DesignOutput.",
      "method": "POST",
      "path": "/v3/designs/pre-builts/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the pre-built Design you want to duplicate.",
          "required": true
        },
        {
          "name": "editor",
          "type": "string",
          "location": "body",
          "description": "The editor used in the UI."
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The name of the new design."
        }
      ]
    },
    {
      "name": "designs_get",
      "description": "**This endpoint allows you to retrieve a single design**. A GET request to `/designs/{id}` will retrieve details about a specific design in your Design Library. This endpoint is valuable when retrieving information stored in a field that you wish to update using a PATCH request. Required: id. Returns the DesignOutput.",
      "method": "GET",
      "path": "/v3/designs/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the Design you want to duplicate.",
          "required": true
        }
      ]
    },
    {
      "name": "designs_get-pre-built",
      "description": "**This endpoint allows you to retrieve a single pre-built design**. A GET request to `/designs/pre-builts/{id}` will retrieve details about a specific pre-built design. This endpoint is valuable when retrieving details about a pre-built design that you wish to duplicate and modify. Required: id. Returns the DesignOutput.",
      "method": "GET",
      "path": "/v3/designs/pre-builts/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the pre-built Design you want to duplicate.",
          "required": true
        }
      ]
    },
    {
      "name": "designs_list",
      "description": "**This endpoint allows you to retrieve a list of designs already stored in your Design Library**. A GET request to `/designs` will return a list of your existing designs. This endpoint will not return the pre-built Twilio SendGrid designs. Pre-built designs can be retrieved using the `/designs/pre-builts` endpoint, which is detailed below. By default, you will receive 100 results per request; however, you can modify the number of results returned by passing an integer to the `page_size` query parameter. Optional: page_size (default: 100), page_token, summary (default: true). Returns the DesignsListResponse.",
      "method": "GET",
      "path": "/v3/designs",
      "params": [
        {
          "name": "page_size",
          "type": "int",
          "location": "query",
          "description": "number of results to return"
        },
        {
          "name": "page_token",
          "type": "string",
          "location": "query",
          "description": "token corresponding to a specific page of results, as provided by metadata"
        },
        {
          "name": "summary",
          "type": "bool",
          "location": "query",
          "description": "set to false to return all fields"
        }
      ]
    },
    {
      "name": "designs_list-pre-built",
      "description": "**This endpoint allows you to retrieve a list of pre-built designs provided by Twilio SendGrid**. Unlike the `/designs` endpoint where *your* designs are stored, a GET request made to `designs/pre-builts` will retrieve a list of the pre-built Twilio SendGrid designs. This endpoint will not return the designs stored in your Design Library. By default, you will receive 100 results per request; however, you can modify the number of results returned by passing an integer to the `page_size` query parameter. This endpoint is useful for retrieving the IDs of Twilio SendGrid designs that you want to duplicate and modify. Optional: page_size (default: 100), page_token, summary (default: true). Returns the DesignsListPreBuiltResponse.",
      "method": "GET",
      "path": "/v3/designs/pre-builts",
      "params": [
        {
          "name": "page_size",
          "type": "int",
          "location": "query",
          "description": "number of results to return"
        },
        {
          "name": "page_token",
          "type": "string",
          "location": "query",
          "description": "token corresponding to a specific page of results, as provided by metadata"
        },
        {
          "name": "summary",
          "type": "bool",
          "location": "query",
          "description": "set to false to return all fields"
        }
      ]
    },
    {
      "name": "designs_update",
      "description": "**This endpoint allows you to edit a design**. The Design API supports PATCH requests, which allow you to make partial updates to a single design. Passing data to a specific field will update only the data stored in that field; all other fields will be unaltered. For example, updating a design's name requires that you make a PATCH request to this endpoint with data specified for the `name` field only. ``` { 'name': '\u003cUpdated Name\u003e' } ```. Required: id. Optional: categories, generate_plain_content (default: true), html_content (plus 3 more). Returns the updated DesignOutput.",
      "method": "PATCH",
      "path": "/v3/designs/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the Design you want to duplicate.",
          "required": true
        },
        {
          "name": "categories",
          "type": "array",
          "location": "body",
          "description": "The list of categories applied to the design"
        },
        {
          "name": "generate_plain_content",
          "type": "bool",
          "location": "body",
          "description": "If true, plain_content is always generated from html_content."
        },
        {
          "name": "html_content",
          "type": "string",
          "location": "body",
          "description": "The HTML content of the Design."
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "Name of the Design."
        },
        {
          "name": "plain_content",
          "type": "string",
          "location": "body",
          "description": "Plain text content of the Design."
        },
        {
          "name": "subject",
          "type": "string",
          "location": "body",
          "description": "Subject of the Design."
        }
      ]
    },
    {
      "name": "devices_list-stat",
      "description": "**This endpoint allows you to retrieve your email statistics segmented by the device type.** **We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. ## Available Device Types | **Device** | **Description** | **Example** | |---|---|---| | Desktop | Email software on desktop computer. | I.E., Outlook, Sparrow, or Apple Mail. | | Webmail |\tA web-based email client. | I.E., Yahoo, Google, AOL, or Outlook.com. | | Phone | A smart phone. | iPhone, Android, Blackberry, etc. | Tablet | A tablet computer. | iPad, android based tablet, etc. | | Other | An unrecognized device. | Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [Statistics Overview](https://sendgrid.com/docs/ui/analytics-and-reporting/stats-overview/). Required: start_date. Optional: limit, offset, aggregated_by (plus 1 more). Returns array of DevicesListStatItem.",
      "method": "GET",
      "path": "/v3/devices/stats",
      "params": [
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "The number of results to return."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The point in the list to begin retrieving results."
        },
        {
          "name": "aggregated_by",
          "type": "string",
          "location": "query",
          "description": "How to group the statistics. Must be either 'day', 'week', or 'month'."
        },
        {
          "name": "start_date",
          "type": "string",
          "location": "query",
          "description": "The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.",
          "required": true
        },
        {
          "name": "end_date",
          "type": "string",
          "location": "query",
          "description": "The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."
        }
      ]
    },
    {
      "name": "engagementquality_list-engagement-quality-score",
      "description": "**This operation allows you to retrieve your SendGrid Engagement Quality (SEQ) scores for a specified date range**. A successful request with this API operation will return either a `200` or `202` response. ### 202 This operation returns a `202` response when SendGrid does not yet have scores available for the specified date range. Scores are calculated asynchronously from requests to this endpoint. This means a score may be available for the specified date at a later time, but a score is not available at the time of your API request. ### 200 A 200 response will include all available scores beginning on the `from` and ending on the `to` dates specified. The `score` and `metrics` properties will be omitted from the response for any days in which the user is not eligible to receive a score. The `score` property represents a user's overall engagement quality. The `metrics` property provides additional scores for the input categories that contribute to that overall score. All scores range from `1` to `5` with a higher number representing better engagement quality. See [**SendGrid Engagement Quality Overview**](https://docs.sendgrid.com/api-reference/sendgrid-engagement-quality-api/overview) for more information. Required: from, to.",
      "method": "GET",
      "path": "/v3/engagementquality/scores",
      "params": [
        {
          "name": "from",
          "type": "string",
          "location": "query",
          "description": "The starting date in YYYY-MM-DD format (UTC) for which you want to retrieve scores.",
          "required": true
        },
        {
          "name": "to",
          "type": "string",
          "location": "query",
          "description": "The ending date in YYYY-MM-DD format (UTC) for which you want to retrieve scores.",
          "required": true
        }
      ]
    },
    {
      "name": "engagementquality_list-subuser-engagement-quality-score",
      "description": "**This operation allows you to retrieve SendGrid Engagement Quality (SEQ) scores for your Subusers or customer accounts for a specific date.** A successful request with this API operation will return either a `200` or `202` response. ### 202 This operation returns a `202` response when SendGrid does not yet have scores available for the specified date range. Scores are calculated asynchronously from requests to this endpoint. This means a score may be available for the specified date at a later time, but a score is not available at the time of your API request. ### 200 A `200` response will include scores for all Subusers or customer accounts belonging to the requesting parent or reseller account. The `score` and `metrics` properties will be omitted from the response if a Subuser or customer account is not eligible to receive a score for the specified date. The `score` property represents a Subuser or customer account's overall engagement quality. The `metrics` property provides additional scores for the input categories that contribute to that overall score. All scores range from `1` to `5` with a higher number representing better engagement quality. See [**SendGrid Engagement Quality Overview**](https://docs.sendgrid.com/api-reference/sendgrid-engagement-quality-api/overview) for more information. Required: date. Optional: limit (default: 1000), after_key.",
      "method": "GET",
      "path": "/v3/engagementquality/subusers/scores",
      "params": [
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "Specifies the number of results to be returned by the API. This parameter can be used to limit the results returned or in combination with the `after_key` parameter to iterate through paginated results."
        },
        {
          "name": "date",
          "type": "string",
          "location": "query",
          "description": "The date in YYYY-MM-DD format (UTC) for which you want to retrieve a SendGrid Engagement Quality score.",
          "required": true
        },
        {
          "name": "after_key",
          "type": "int",
          "location": "query",
          "description": "Specifies which items to be returned by the API."
        }
      ]
    },
    {
      "name": "geo_list-stat",
      "description": "**This endpoint allows you to retrieve your email statistics segmented by country and state/province.** **We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. For Regional (EU) subusers, this service is not available due to PII restrictions. Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [User Guide](https://wwww.twilio.com/docs/sendgrid/ui/analytics-and-reporting/stats-overview). Required: start_date. Optional: country, limit, offset (plus 2 more). Returns array of GeoListStatItem.",
      "method": "GET",
      "path": "/v3/geo/stats",
      "params": [
        {
          "name": "country",
          "type": "string",
          "location": "query",
          "description": "The country you would like to see statistics for. Currently only supported for US and CA."
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "The number of results to return."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The point in the list to begin retrieving results."
        },
        {
          "name": "aggregated_by",
          "type": "string",
          "location": "query",
          "description": "How to group the statistics. Must be either 'day', 'week', or 'month'."
        },
        {
          "name": "start_date",
          "type": "string",
          "location": "query",
          "description": "The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.",
          "required": true
        },
        {
          "name": "end_date",
          "type": "string",
          "location": "query",
          "description": "The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."
        }
      ]
    },
    {
      "name": "ips_add",
      "description": "**This endpoint is for adding a(n) IP Address(es) to your account.**. Required: count. Optional: subusers, warmup (default: false). Returns the new IpsAddResponse.",
      "method": "POST",
      "path": "/v3/ips",
      "params": [
        {
          "name": "count",
          "type": "int",
          "location": "body",
          "description": "The amount of IPs to add to the account.",
          "required": true
        },
        {
          "name": "subusers",
          "type": "array",
          "location": "body",
          "description": "Array of usernames to be assigned a send IP."
        },
        {
          "name": "warmup",
          "type": "bool",
          "location": "body",
          "description": "Whether or not to warmup the IPs being added."
        }
      ]
    },
    {
      "name": "ips_add-to-pool",
      "description": "**This endpoint allows you to add an IP address to an IP pool.** You can add the same IP address to multiple pools. It may take up to 60 seconds for your IP address to be added to a pool after your request is made. Before you can add an IP to a pool, you need to activate it in your SendGrid account: 1. Log into your SendGrid account. 1. Navigate to **Settings** and then select **IP Addresses**. 1. Find the IP address you want to activate and then click **Edit**. 1. Check **Allow my account to send mail using this IP address**. 1. Click **Save**. You can retrieve all of your available IP addresses from the 'Retrieve all IP addresses' endpoint. Required: pool_name. Optional: ip. Returns the new IpsAddToPoolResponse.",
      "method": "POST",
      "path": "/v3/ips/pools/{pool_name}/ips",
      "params": [
        {
          "name": "pool_name",
          "type": "string",
          "location": "path",
          "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 'Test%20Pool').",
          "required": true
        },
        {
          "name": "ip",
          "type": "string",
          "location": "body",
          "description": "The IP address that you want to add to the named pool."
        }
      ]
    },
    {
      "name": "ips_create-pool",
      "description": "**This endpoint allows you to create an IP pool.** Before you can create an IP pool, you need to activate the IP in your SendGrid account: 1. Log into your SendGrid account. 1. Navigate to **Settings** and then select **IP Addresses**. 1. Find the IP address you want to activate and then click **Edit**. 1. Check **Allow my account to send mail using this IP address**. 1. Click **Save**. Required: name. Returns the new IpPools200.",
      "method": "POST",
      "path": "/v3/ips/pools",
      "params": [
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The name of your new IP pool.",
          "required": true
        }
      ]
    },
    {
      "name": "ips_delete-from-pool",
      "description": "**This endpoint allows you to remove an IP address from an IP pool.**. Required: pool_name, ip. Destructive.",
      "method": "DELETE",
      "path": "/v3/ips/pools/{pool_name}/ips/{ip}",
      "params": [
        {
          "name": "pool_name",
          "type": "string",
          "location": "path",
          "description": "The name of the IP pool that you are removing the IP address from.",
          "required": true
        },
        {
          "name": "ip",
          "type": "string",
          "location": "path",
          "description": "The IP address that you wish to remove.",
          "required": true
        }
      ]
    },
    {
      "name": "ips_delete-pool",
      "description": "**This endpoint allows you to delete an IP pool.**. Required: pool_name. Destructive.",
      "method": "DELETE",
      "path": "/v3/ips/pools/{pool_name}",
      "params": [
        {
          "name": "pool_name",
          "type": "string",
          "location": "path",
          "description": "The name of the IP pool that you want to retrieve the IP addresses for.",
          "required": true
        }
      ]
    },
    {
      "name": "ips_get",
      "description": "**This endpoint allows you to see which IP pools a particular IP address has been added to.** The same IP address can be added to multiple IP pools. A single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it. Required: ip_address. Returns the IpsGetResponse.",
      "method": "GET",
      "path": "/v3/ips/{ip_address}",
      "params": [
        {
          "name": "ip_address",
          "type": "string",
          "location": "path",
          "description": "The IP address you are retrieving the IP pools for.",
          "required": true
        }
      ]
    },
    {
      "name": "ips_get-pool",
      "description": "**This endpoint allows you to get all of the IP addresses that are in a specific IP pool.**. Required: pool_name. Returns the IpsGetPoolResponse.",
      "method": "GET",
      "path": "/v3/ips/pools/{pool_name}",
      "params": [
        {
          "name": "pool_name",
          "type": "string",
          "location": "path",
          "description": "The name of the IP pool that you want to retrieve the IP addresses for.",
          "required": true
        }
      ]
    },
    {
      "name": "ips_get-warm-up",
      "description": "**This endpoint allows you to retrieve the warmup status for a specific IP address.** You can retrieve all of your warming IPs using the 'Retrieve all IPs currently in warmup' endpoint. Required: ip_address. Returns array of IpsGetWarmUpItem.",
      "method": "GET",
      "path": "/v3/ips/warmup/{ip_address}",
      "params": [
        {
          "name": "ip_address",
          "type": "string",
          "location": "path",
          "description": "The IP address that you want to retrieve the warmup status for.",
          "required": true
        }
      ]
    },
    {
      "name": "ips_list",
      "description": "**This endpoint allows you to retrieve a paginated list of all assigned and unassigned IPs.** Response includes warm up status, pools, assigned subusers, and reverse DNS info. The start_date field corresponds to when warmup started for that IP. A single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is determined by the aggregate performance of all email traffic sent from it. You can use the `limit` query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the `offset` query parameter to control the position in the list from which to start retrieving additional items. Optional: ip, exclude_whitelabels, limit (default: 10) (plus 3 more). Returns array of IpsListItem.",
      "method": "GET",
      "path": "/v3/ips",
      "params": [
        {
          "name": "ip",
          "type": "string",
          "location": "query",
          "description": "The IP address to get"
        },
        {
          "name": "exclude_whitelabels",
          "type": "bool",
          "location": "query",
          "description": "Should we exclude reverse DNS records (whitelabels)?"
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "`limit` sets the page size, i."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The number of items in the list to skip over before starting to retrieve the items for the..."
        },
        {
          "name": "subuser",
          "type": "string",
          "location": "query",
          "description": "The subuser you are requesting for."
        },
        {
          "name": "sort_by_direction",
          "type": "string",
          "location": "query",
          "description": "The direction to sort the results."
        }
      ]
    },
    {
      "name": "ips_list-assigned",
      "description": "**This endpoint allows you to retrieve only assigned IP addresses.** A single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it. Returns array of IpsListAssignedItem.",
      "method": "GET",
      "path": "/v3/ips/assigned",
      "params": []
    },
    {
      "name": "ips_list-pool",
      "description": "**This endpoint allows you to get all of your IP pools.**. Returns array of IpPools200.",
      "method": "GET",
      "path": "/v3/ips/pools",
      "params": []
    },
    {
      "name": "ips_list-remaining-count",
      "description": "**This endpoint gets amount of IP Addresses that can still be created during a given period and the price of those IPs.**. Returns the IpsListRemainingCountResponse.",
      "method": "GET",
      "path": "/v3/ips/remaining",
      "params": []
    },
    {
      "name": "ips_list-warm-up",
      "description": "**This endpoint allows you to retrieve all of your IP addresses that are currently warming up.**. Returns array of IpsListWarmUpItem.",
      "method": "GET",
      "path": "/v3/ips/warmup",
      "params": []
    },
    {
      "name": "ips_stop-warm-up",
      "description": "**This endpoint allows you to remove an IP address from warmup mode.** Your request will return a 204 status code if the specified IP was successfully removed from warmup mode. To retrieve details of the IP’s warmup status *before* removing it from warmup mode, call the 'Retrieve the warmpup status for a specific IP address' endpoint. Required: ip_address. Destructive.",
      "method": "DELETE",
      "path": "/v3/ips/warmup/{ip_address}",
      "params": [
        {
          "name": "ip_address",
          "type": "string",
          "location": "path",
          "description": "The IP address that you want to retrieve the warmup status for.",
          "required": true
        }
      ]
    },
    {
      "name": "ips_update-pool",
      "description": "**This endpoint allows you to update the name of an IP pool.**. Required: pool_name. Optional: name. Returns the updated IpPools200.",
      "method": "PUT",
      "path": "/v3/ips/pools/{pool_name}",
      "params": [
        {
          "name": "pool_name",
          "type": "string",
          "location": "path",
          "description": "The name of the IP pool that you want to retrieve the IP addresses for.",
          "required": true
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The new name for your IP pool."
        }
      ]
    },
    {
      "name": "ips_warm-up",
      "description": "**This endpoint allows you to put an IP address into warmup mode.**. Optional: ip. Returns array of IpsWarmUpItem.",
      "method": "POST",
      "path": "/v3/ips/warmup",
      "params": [
        {
          "name": "ip",
          "type": "string",
          "location": "body",
          "description": "The IP address that you want to begin warming up."
        }
      ]
    },
    {
      "name": "logs_get-message-by-id",
      "description": "Get all of the details about the specified message. Required: sg_message_id. Optional: subuser. Returns the EmailLogsGetMessageByIdResponse.",
      "method": "GET",
      "path": "/v3/logs/{sg_message_id}",
      "params": [
        {
          "name": "sg_message_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the message you are requesting details for.",
          "required": true
        },
        {
          "name": "subuser",
          "type": "string",
          "location": "query",
          "description": "For requests authenticated as the parent account, this argument must be passed if the desired message belongs to a subuser."
        }
      ]
    },
    {
      "name": "logs_list-messages-by-filter",
      "description": "List recent messages within Email Logs, or search for messages using a filter. Optional: limit (default: 10), query, subusers. Returns the new EmailLogsGetMessagesByFilterResponse.",
      "method": "POST",
      "path": "/v3/logs",
      "params": [
        {
          "name": "limit",
          "type": "int",
          "location": "body",
          "description": "Number of messages to return (1–1000)."
        },
        {
          "name": "query",
          "type": "string",
          "location": "body",
          "description": "**Allowed event fields and operators** - sg_message_id: `=` - subject: `=` - to_email: `=` - status: `IN` - reason: `=` - categories: `IN` - sg_message_id_created_at: `\u003e`, `\u003c`, `\u003e=`, `\u003c=` **Notes:** - multiple conditions (up to 160) can be combined with `AND` - nesting is not allowed - `IN` operator accepts a list of string values: `field IN ('value1', 'value2')`"
        },
        {
          "name": "subusers",
          "type": "array",
          "location": "body",
          "description": "For requests authenticated as the parent account, this argument must be passed if the desired messages belong to a subuser. You can only call this endpoint for 1 subuser at a time."
        }
      ]
    },
    {
      "name": "mail_create-batch",
      "description": "**This operation allows you to generate a new mail batch ID.** Once a batch ID is created, you can associate it with a mail send by passing it in the request body of the [Mail Send operation](https://docs.sendgrid.com/api-reference/mail-send/mail-send). This makes it possible to group multiple requests to the Mail Send operation by assigning them the same batch ID. A batch ID that's associated with a mail send can be used to access and modify the associated send. For example, you can pause or cancel a send using its batch ID. See the [Scheduled Sends API](https://www.twilio.com/docs/sendgrid/api-reference/cancel-scheduled-sends) for more information about pausing and cancelling a mail send. Returns the new MailBatchResponse.",
      "method": "POST",
      "path": "/v3/mail/batch",
      "params": []
    },
    {
      "name": "mail_get-batch",
      "description": "**This operation allows you to validate a mail batch ID.** If you provide a valid batch ID, this operation will return a `200` status code and the batch ID itself. If you provide an invalid batch ID, you will receive a `400` level status code and an error message. A batch ID does not need to be assigned to a send to be considered valid. A successful response means only that the batch ID has been created, but it does not indicate that the ID has been assigned to a send. Required: batch_id. Returns the MailBatchResponse.",
      "method": "GET",
      "path": "/v3/mail/batch/{batch_id}",
      "params": [
        {
          "name": "batch_id",
          "type": "string",
          "location": "path",
          "description": "Set this parameter to the batch ID that's associated with the mail send you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "mail_send",
      "description": "*The Mail Send operation allows you to send email over SendGrid's v3 Web API* For an overview of this API, including its features and limitations, please see the [Mail Send API overview page](https://www.twilio.com/docs/sendgrid/api-reference/mail-send) The overview page also includes links to SendGrid's Email API quickstarts and helper libraries to get you working with this endpoint even faster. Required: from, personalizations. Optional: asm, attachments, batch_id (plus 12 more).",
      "method": "POST",
      "path": "/v3/mail/send",
      "params": [
        {
          "name": "asm",
          "type": "object",
          "location": "body",
          "description": "An object allowing you to specify how to handle unsubscribes. With SendGrid, an unsubscribe is the action an email recipient takes when they opt-out of receiving your messages. A suppression is the action you take as a sender to filter or suppress an unsubscribed address from your email send. From the perspective of the recipient, your suppression is the result of their unsubscribe. See [**Suppression Groups**](https://www.twilio.com/docs/sendgrid/api-reference/suppressions-unsubscribe-groups/create-a-new-suppression-group) for more information."
        },
        {
          "name": "attachments",
          "type": "array",
          "location": "body",
          "description": "An array of objects where you can define any attachments to be included with the message. Each object contains a `content` property, which must be a Base64 encoded string of the attachment itself, and `type`, `filename`, `disposition`, and `content_id` properties that tell SendGrid how to handle the attachment."
        },
        {
          "name": "batch_id",
          "type": "string",
          "location": "body",
          "description": "An ID representing a batch of emails to be sent at the same time. Including a `batch_id` in your request allows you to include this email in that batch. It also enables you to cancel or pause the delivery of that batch. See the [Scheduled Sends API](https://sendgrid.com/docs/api-reference/) for more information about scheduling your email."
        },
        {
          "name": "categories",
          "type": "array",
          "location": "body",
          "description": "An array of category names assigned to this message. Categories allow you to group messages by categories you define. Categories should be used sparingly to create general groups that are relevant to you. Categories are not meant to be used to track individual mail sends. For more granular categorization and tracking, use the `custom_args` property. A category name cannot exceed 255 characters. See [**Working with Categories**](https://docs.sendgrid.com/for-developers/sending-email/categories) for more information."
        },
        {
          "name": "content",
          "type": "array",
          "location": "body",
          "description": "An array of objects, each containing a message body's content and [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types). You must specify at least one MIME type and may include multiple. To include more than one MIME type, add an object for each type to the array."
        },
        {
          "name": "custom_args",
          "type": "string",
          "location": "body",
          "description": "Values that are specific to the entire send that will be carried along with the email and its activity data. Substitutions will not be made on custom arguments, so any string that is assigned to this property will be assumed to be the custom argument that you would like to be used. This parameter is overridden by `custom_args` set at the personalizations level. Total `custom_args` size may not exceed 10,000 bytes."
        },
        {
          "name": "from",
          "type": "object",
          "location": "body",
          "description": "From",
          "required": true
        },
        {
          "name": "headers",
          "type": "object",
          "location": "body",
          "description": "A collection of JSON property name and property value pairs allowing you to specify handling instructions for your email. You may not override the following headers: `x-sg-id`, `x-sg-eid`, `received`, `dkim-signature`, `Content-Type`, `Content-Transfer-Encoding`, `To`, `From`, `Subject`, `Reply-To`, `CC`, `BCC`."
        },
        {
          "name": "ip_pool_name",
          "type": "string",
          "location": "body",
          "description": "The IP Pool that you would like to send this email from. IP Pools allow you to group your dedicated Twilio SendGrid IP addresses in order to have more control over your deliverability. See [**IP Pools**](https://docs.sendgrid.com/ui/account-and-settings/ip-pools) for more information."
        },
        {
          "name": "mail_settings",
          "type": "object",
          "location": "body",
          "description": "A collection of different mail settings that you can use to specify how you would like this email to be handled. Mail settings provide extra functionality to your mail send. See [**Mail Settings**](https://docs.sendgrid.com/ui/account-and-settings/mail) for more information."
        },
        {
          "name": "personalizations",
          "type": "array",
          "location": "body",
          "description": "An array of messages and their metadata. Each object within the `personalizations` array can be thought of as a mail envelope—it defines who should receive an individual message and how that message should be handled. See [**Personalizations**](https://sendgrid.com/docs/for-developers/sending-email/personalizations/) for more information.",
          "required": true
        },
        {
          "name": "reply_to",
          "type": "object",
          "location": "body",
          "description": "Reply to"
        },
        {
          "name": "reply_to_list",
          "type": "array",
          "location": "body",
          "description": "An array of recipients to whom replies will be sent. Each object in this array must contain a recipient's email address. Each object in the array may optionally contain a recipient's name. You can use either the `reply_to` property or `reply_to_list` property but not both."
        },
        {
          "name": "send_at",
          "type": "int",
          "location": "body",
          "description": "A [unix timestamp](https://en.wikipedia.org/wiki/Unix_time) allowing you to specify when your email should be sent. A send cannot be scheduled more than 72 hours in advance. This property may be overridden by the `send_at` property set at the personalizations level."
        },
        {
          "name": "subject",
          "type": "string",
          "location": "body",
          "description": "The global or _message level_ subject of your email. Subject lines set in personalizations objects will override this global subject line. See line length limits specified in [RFC 2822](https://www.rfc-editor.org/rfc/rfc2822#section-2.1.1) for guidance on subject line character limits."
        },
        {
          "name": "template_id",
          "type": "string",
          "location": "body",
          "description": "An email template ID. A template that contains a subject and content—either text or html—will override any subject and content values specified at the `personalizations` or message level. If a template ID begins with `d-`, it is a dynamic template and will work with the `dynamic_template_data` property. If the template ID does not begin with `d-`, it is a standard SendGrid template and will work with the `substitutions` property. See [**How to Send an Email with Dynamic Templates**](https://docs.sendgrid.com/ui/sending-email/how-to-send-an-email-with-dynamic-templates) for more information about working with templates."
        },
        {
          "name": "tracking_settings",
          "type": "object",
          "location": "body",
          "description": "Settings to determine how you would like to track the metrics of how your recipients interact with your email. See [**Tracking Settings**](https://docs.sendgrid.com/ui/account-and-settings/tracking) for more information."
        }
      ]
    },
    {
      "name": "mail-settings_list",
      "description": "**This endpoint allows you to retrieve a paginated list of all mail settings.** Each setting will be returned with an `enabled` status set to `true` or `false` and a short description that explains what the setting does. You can use the `limit` query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the `offset` query parameter to control the position in the list from which to start retrieving additional items. Optional: limit, offset (default: 0). Returns the MailSettingsListResponse.",
      "method": "GET",
      "path": "/v3/mail_settings",
      "params": [
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "`limit` sets the page size, i."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The number of items in the list to skip over before starting to retrieve the items for the..."
        }
      ]
    },
    {
      "name": "mail-settings_list-address-whitelist",
      "description": "**This endpoint allows you to retrieve your current email address whitelist settings.** The Address Whitelist setting allows you to specify email addresses or domains for which mail should never be suppressed. For Regional Subusers - Utilizing this feature for Regional (EU) subusers will cause customer personal information to be stored outside of the EU. For example, if you own the domain `example.com`, and one or more of your recipients use `email@example.com` addresses, placing `example.com` in the address whitelist setting instructs Twilio SendGrid to ignore all bounces, blocks, and unsubscribes logged for that domain. In other words, all bounces, blocks, and unsubscribes will still be sent to `example.com` as if they were sent under normal sending conditions. Returns the MailSettingsAddressWhitelabel200.",
      "method": "GET",
      "path": "/v3/mail_settings/address_whitelist",
      "params": []
    },
    {
      "name": "mail-settings_list-bounce-purge",
      "description": "**This endpoint allows you to retrieve your current Bounce Purge mail settings.** The Bounce Purge mail setting allows you to configure the maximum age of contacts in your hard and soft bounce suppressions lists. All contacts older than their respective configured age are deleted. A hard bounce occurs when an email message has been returned to the sender because the recipient's address is invalid. A hard bounce might occur because the domain name doesn't exist or because the recipient is unknown. A soft bounce occurs when an email message reaches the recipient's mail server but is bounced back undelivered before it actually reaches the recipient. A soft bounce might occur because the recipient's inbox is full. You can also manage this setting in the [Mail Settings section of the Twilio SendGrid App](https://app.sendgrid.com/settings/mail_settings). You can manage your bounces manually using the [Bounces API](https://docs.sendgrid.com/api-reference/bounces-api) or the [Bounces menu in the Twilio SendGrid App](https://app.sendgrid.com/suppressions/bounces). Returns the MailSettingsBouncePurge.",
      "method": "GET",
      "path": "/v3/mail_settings/bounce_purge",
      "params": []
    },
    {
      "name": "mail-settings_list-footer",
      "description": "**This endpoint allows you to retrieve your current Footer mail settings.** The Footer setting will insert a custom footer at the bottom of your text and HTML email message bodies. You can insert your HTML or plain text directly using the 'Update footer mail settings' endpoint, or you can create the footer using the [Mail Settings menu in the Twilio SendGrid App](https://app.sendgrid.com/settings/mail_settings). Returns the MailSettingsFooter.",
      "method": "GET",
      "path": "/v3/mail_settings/footer",
      "params": []
    },
    {
      "name": "mail-settings_list-forward-bounce",
      "description": "**This endpoint allows you to retrieve your current bounce forwarding mail settings.** Enabling the Forward Bounce setting allows you to specify `email` addresses to which bounce reports will be forwarded. This endpoint returns the email address you have set to receive forwarded bounces and an `enabled` status indicating if the setting is active.",
      "method": "GET",
      "path": "/v3/mail_settings/forward_bounce",
      "params": []
    },
    {
      "name": "mail-settings_list-forward-spam",
      "description": "**This endpoint allows you to retrieve your current Forward Spam mail settings.** Enabling the Forward Spam setting allows you to specify `email` addresses to which spam reports will be forwarded. This endpoint returns any email address(es) you have set to receive forwarded spam and an `enabled` status indicating if the setting is active.",
      "method": "GET",
      "path": "/v3/mail_settings/forward_spam",
      "params": []
    },
    {
      "name": "mail-settings_list-template",
      "description": "**This endpoint allows you to retrieve your current legacy email template settings.** This setting refers to our original email templates. We currently support more fully featured [Dynamic Transactional Templates](https://sendgrid.com/docs/ui/sending-email/how-to-send-an-email-with-dynamic-transactional-templates/). The legacy email template setting wraps an HTML template around your email content. This can be useful for sending out marketing email and/or other HTML formatted messages. For instructions on using legacy templates, see how to ['Create and Edit Legacy Transactional Templates](https://sendgrid.com/docs/ui/sending-email/create-and-edit-legacy-transactional-templates/). For help migrating to our current template system, see ['Migrating from Legacy Templates'](https://sendgrid.com/docs/ui/sending-email/migrating-from-legacy-templates/). Returns the MailSettingsTemplate200.",
      "method": "GET",
      "path": "/v3/mail_settings/template",
      "params": []
    },
    {
      "name": "mail-settings_update-address-whitelist",
      "description": "**This endpoint allows you to update your current email address whitelist settings.** For Regional Subusers - Utilizing this feature for Regional (EU) subusers will cause customer personal information to be stored outside of the EU. You can select whether or not this setting should be enabled by assigning the `enabled` field a `true` or `false` value. Passing only the `enabled` field to this endpoint will not alter your current `list` of whitelist entries. However, any modifications to your `list` of entries will overwrite the entire list. For this reason, you must included all existing entries you wish to retain in your `list` in addition to any new entries you intend to add. To remove one or more `list` entries, pass a `list` with only the entries you wish to retain. You should not add generic domains such as `gmail.com` or `yahoo.com` in your `list` because your emails will not honor recipients' unsubscribes. This may cause a legal violation of [CAN-SPAM](https://sendgrid.com/docs/glossary/can-spam/) and could damage your sending reputation. The Address Whitelist setting allows you to specify email addresses or domains for which mail should never be suppressed. For example, if you own the domain `example.com`, and one or more of your recipients use `email@example.com` addresses, placing `example.com` in the address whitelist setting instructs Twilio SendGrid to ignore all bounces, blocks, and unsubscribes logged for that domain. In other words, all bounces, blocks, and unsubscribes will still be sent to `example.com` as if they were sent under normal sending conditions. Optional: enabled, list. Returns the updated MailSettingsAddressWhitelabel200.",
      "method": "PATCH",
      "path": "/v3/mail_settings/address_whitelist",
      "params": [
        {
          "name": "enabled",
          "type": "bool",
          "location": "body",
          "description": "Indicates if your email address whitelist is enabled."
        },
        {
          "name": "list",
          "type": "array",
          "location": "body",
          "description": "Either a single email address that you want whitelisted or a domain, for which all email addresses belonging to this domain will be whitelisted."
        }
      ]
    },
    {
      "name": "mail-settings_update-bounce-purge",
      "description": "**This endpoint allows you to update your current Bounce Purge mail settings.** The Bounce Purge mail metting allows you to configure the maximum age of contacts in your hard and soft bounce suppressions lists. All contacts older than their respective configured age are deleted. A hard bounce occurs when an email message has been returned to the sender because the recipient's address is invalid. A hard bounce might occur because the domain name doesn't exist or because the recipient is unknown. A soft bounce occurs when an email message reaches the recipient's mail server but is bounced back undelivered before it actually reaches the recipient. A soft bounce might occur because the recipient's inbox is full. You can also manage this setting in the [Mail Settings section of the Twilio SendGrid App](https://app.sendgrid.com/settings/mail_settings). You can manage your bounces manually using the [Bounces API](https://docs.sendgrid.com/api-reference/bounces-api) or the [Bounces menu in the Twilio SendGrid App](https://app.sendgrid.com/suppressions/bounces). Optional: enabled, hard_bounces, soft_bounces. Returns the updated MailSettingsBouncePurge.",
      "method": "PATCH",
      "path": "/v3/mail_settings/bounce_purge",
      "params": [
        {
          "name": "enabled",
          "type": "bool",
          "location": "body",
          "description": "Indicates if the Bounce Purge mail setting is enabled."
        },
        {
          "name": "hard_bounces",
          "type": "int",
          "location": "body",
          "description": "The number of days after which SendGrid will purge all contacts from your hard bounces suppression lists."
        },
        {
          "name": "soft_bounces",
          "type": "int",
          "location": "body",
          "description": "The number of days after which SendGrid will purge all contacts from your soft bounces suppression lists."
        }
      ]
    },
    {
      "name": "mail-settings_update-footer",
      "description": "**This endpoint allows you to update your current Footer mail settings.** The Footer setting will insert a custom footer at the bottom of your text and HTML email message bodies. You can insert your HTML or plain text directly using this endpoint, or you can create the footer using the [Mail Settings menu in the Twilio SendGrid App](https://app.sendgrid.com/settings/mail_settings). Optional: enabled, html_content, plain_content. Returns the updated MailSettingsFooter.",
      "method": "PATCH",
      "path": "/v3/mail_settings/footer",
      "params": [
        {
          "name": "enabled",
          "type": "bool",
          "location": "body",
          "description": "Indicates if the Footer mail setting is currently enabled."
        },
        {
          "name": "html_content",
          "type": "string",
          "location": "body",
          "description": "The custom HTML content of your email footer."
        },
        {
          "name": "plain_content",
          "type": "string",
          "location": "body",
          "description": "The plain text content of your email footer."
        }
      ]
    },
    {
      "name": "mail-settings_update-forward-bounce",
      "description": "**This endpoint allows you to update your current bounce forwarding mail settings.** Enabling the Forward Bounce setting allows you to specify an `email` address to which bounce reports will be forwarded. You can also configure the Forward Spam mail settings in the [Mail Settings section of the Twilio SendGrid App](https://app.sendgrid.com/settings/mail_settings). Optional: email, enabled. Returns the updated MailSettingsForwardBounce.",
      "method": "PATCH",
      "path": "/v3/mail_settings/forward_bounce",
      "params": [
        {
          "name": "email",
          "type": "string",
          "location": "body",
          "description": "The email address that you would like your bounce reports forwarded to."
        },
        {
          "name": "enabled",
          "type": "bool",
          "location": "body",
          "description": "Indicates if the bounce forwarding mail setting is enabled."
        }
      ]
    },
    {
      "name": "mail-settings_update-forward-spam",
      "description": "**This endpoint allows you to update your current Forward Spam mail settings.** Enabling the Forward Spam setting allows you to specify `email` addresses to which spam reports will be forwarded. You can set multiple addresses by passing this endpoint a comma separated list of emails in a single string. ``` { 'email': 'address1@example.com, address2@exapmle.com', 'enabled': true } ``` The Forward Spam setting may also be used to receive emails sent to `abuse@` and `postmaster@` role addresses if you have authenticated your domain. For example, if you authenticated `example.com` as your root domain and set a custom return path of `sub` for that domain, you could turn on Forward Spam, and any emails sent to `abuse@sub.example.com` or `postmaster@sub.example.com` would be forwarded to the email address you entered in the `email` field. You can authenticate your domain using the 'Authenticate a domain' endpoint or in the [Sender Authentication section of the Twilio SendGrid App](https://app.sendgrid.com/settings/sender_auth). You can also configure the Forward Spam mail settings in the [Mail Settings section of the Twilio SendGrid App](https://app.sendgrid.com/settings/mail_settings). Optional: email, enabled. Returns the updated MailSettingsForwardSpam.",
      "method": "PATCH",
      "path": "/v3/mail_settings/forward_spam",
      "params": [
        {
          "name": "email",
          "type": "string",
          "location": "body",
          "description": "The email address where you would like the spam reports to be forwarded."
        },
        {
          "name": "enabled",
          "type": "bool",
          "location": "body",
          "description": "Indicates if the Forward Spam setting is enabled."
        }
      ]
    },
    {
      "name": "mail-settings_update-template",
      "description": "**This endpoint allows you to update your current legacy email template settings.** This setting refers to our original email templates. We currently support more fully featured [Dynamic Transactional Templates](https://sendgrid.com/docs/ui/sending-email/how-to-send-an-email-with-dynamic-transactional-templates/). The legacy email template setting wraps an HTML template around your email content. This can be useful for sending out marketing email and/or other HTML formatted messages. For instructions on using legacy templates, see how to ['Create and Edit Legacy Transactional Templates](https://sendgrid.com/docs/ui/sending-email/create-and-edit-legacy-transactional-templates/). For help migrating to our current template system, see ['Migrating from Legacy Templates'](https://sendgrid.com/docs/ui/sending-email/migrating-from-legacy-templates/). Optional: enabled, html_content. Returns the updated MailSettingsUpdateTemplateResponse.",
      "method": "PATCH",
      "path": "/v3/mail_settings/template",
      "params": [
        {
          "name": "enabled",
          "type": "bool",
          "location": "body",
          "description": "Indicates if you want to enable the legacy email template mail setting."
        },
        {
          "name": "html_content",
          "type": "string",
          "location": "body",
          "description": "The new HTML content for your legacy email template."
        }
      ]
    },
    {
      "name": "mailbox-providers_list-stat",
      "description": "**This endpoint allows you to retrieve your email statistics segmented by recipient mailbox provider.** **We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [Statistics Overview](https://sendgrid.com/docs/ui/analytics-and-reporting/stats-overview/). Required: start_date. Optional: mailbox_providers, limit, offset (plus 2 more). Returns array of MailboxProvidersListStatItem.",
      "method": "GET",
      "path": "/v3/mailbox_providers/stats",
      "params": [
        {
          "name": "mailbox_providers",
          "type": "string",
          "location": "query",
          "description": "The mail box providers to get statistics for. You can include up to 10 by including this parameter multiple times."
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "The number of results to return."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The point in the list to begin retrieving results."
        },
        {
          "name": "aggregated_by",
          "type": "string",
          "location": "query",
          "description": "How to group the statistics. Must be either 'day', 'week', or 'month'."
        },
        {
          "name": "start_date",
          "type": "string",
          "location": "query",
          "description": "The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.",
          "required": true
        },
        {
          "name": "end_date",
          "type": "string",
          "location": "query",
          "description": "The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."
        }
      ]
    },
    {
      "name": "marketing_add-integration",
      "description": "This endpoint creates an Integration for email event forwarding. Each Integration has a maximum number of allowed Integration instances per user. For example, users can create up to 10 Segment Integrations. Required: destination, filters, properties. Optional: label (default: Untitled Integration). Returns the new Integration.",
      "method": "POST",
      "path": "/v3/marketing/integrations",
      "params": [
        {
          "name": "destination",
          "type": "string",
          "location": "body",
          "description": "The third-party application you would like to forward your events to.",
          "required": true
        },
        {
          "name": "filters",
          "type": "object",
          "location": "body",
          "description": "The configurable filters for SendGrid to destination email event forwarding.",
          "required": true
        },
        {
          "name": "label",
          "type": "string",
          "location": "body",
          "description": "The nickname for the Integration."
        },
        {
          "name": "properties",
          "type": "object",
          "location": "body",
          "description": "The properties of an Integration required to send events to a specific third-party application.",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_create-field-definition",
      "description": "**This endpoint creates a new custom field definition.** Custom field definitions are created with the given `name` and `field_type`. Although field names are stored in a case-sensitive manner, all field names must be case-insensitively unique. This means you may create a field named `CamelCase` or `camelcase`, but not both. Additionally, a Custom Field name cannot collide with any Reserved Field names. You should save the returned `id` value in order to update or delete the field at a later date. You can have up to 500 custom fields. The custom field name should be created using only alphanumeric characters (A-Z and 0-9) and underscores (_). Custom fields can only begin with letters A-Z or underscores (_). The field type can be date, text, or number fields. The field type is important for creating segments from your contact database. **Note: Creating a custom field that begins with a number will cause issues with sending in Marketing Campaigns.**. Required: field_type, name. Returns the new MarketingCreateFieldDefinitionResponse.",
      "method": "POST",
      "path": "/v3/marketing/field_definitions",
      "params": [
        {
          "name": "field_type",
          "type": "string",
          "location": "body",
          "description": "Field type",
          "required": true
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "Name",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_create-list",
      "description": "**This endpoint creates a new contacts list.** Once you create a list, you can use the UI to [trigger an automation](https://sendgrid.com/docs/ui/sending-email/getting-started-with-automation/#create-an-automation) every time you add a new contact to the list. A link to the newly created object is in `_metadata`. Required: name. Returns the new List.",
      "method": "POST",
      "path": "/v3/marketing/lists",
      "params": [
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "Your name for your list",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_create-segment",
      "description": "Segment `name` has to be unique. A user can not create a new segment with an existing segment name. Required: name, query_dsl. Optional: parent_list_ids. Returns the new Segment2xx.",
      "method": "POST",
      "path": "/v3/marketing/segments/2.0",
      "params": [
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "Name of the segment.",
          "required": true
        },
        {
          "name": "parent_list_ids",
          "type": "array",
          "location": "body",
          "description": "The array of list ids to filter contacts on when building this segment. It allows only one such list id for now. We will support more in future"
        },
        {
          "name": "query_dsl",
          "type": "string",
          "location": "body",
          "description": "SQL query which will filter contacts based on the conditions provided",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_create-sender",
      "description": "**This endpoint allows you to create a new Sender.** *You may create up to 100 unique Senders.* Senders are required to be verified before use. If your domain has been authenticated, a new Sender will auto verify on creation. Otherwise an email will be sent to the `from.email`. Required: address, city, country, from, nickname, reply_to. Optional: address_2, state, zip. Returns the new Sender.",
      "method": "POST",
      "path": "/v3/marketing/senders",
      "params": [
        {
          "name": "address",
          "type": "string",
          "location": "body",
          "description": "The physical address of the Sender.",
          "required": true
        },
        {
          "name": "address_2",
          "type": "string",
          "location": "body",
          "description": "Additional Sender address information."
        },
        {
          "name": "city",
          "type": "string",
          "location": "body",
          "description": "The city of the Sender.",
          "required": true
        },
        {
          "name": "country",
          "type": "string",
          "location": "body",
          "description": "The country of the Sender.",
          "required": true
        },
        {
          "name": "from",
          "type": "object",
          "location": "body",
          "description": "From",
          "required": true
        },
        {
          "name": "nickname",
          "type": "string",
          "location": "body",
          "description": "A nickname for the Sender. Not used for sending.",
          "required": true
        },
        {
          "name": "reply_to",
          "type": "object",
          "location": "body",
          "description": "Reply to",
          "required": true
        },
        {
          "name": "state",
          "type": "string",
          "location": "body",
          "description": "The state of the Sender."
        },
        {
          "name": "zip",
          "type": "string",
          "location": "body",
          "description": "The zipcode of the Sender."
        }
      ]
    },
    {
      "name": "marketing_create-single-send",
      "description": "**This endpoint allows you to create a new Single Send.** Please note that if you are migrating from the previous version of Single Sends, you no longer need to pass a template ID with your request to this endpoint. Instead, you will pass all template data in the `email_config` object. This endpoint will create a draft of the Single Send but will not send it or schedule it to be sent. Any `send_at` property value set with this endpoint will prepopulate the Single Send's send date. However, the Single Send will remain an unscheduled draft until it's updated with the [**Schedule Single Send**](https://docs.sendgrid.com/api-reference/single-sends/schedule-single-send) endpoint or SendGrid application UI. Required: name. Optional: categories, email_config, send_at (plus 1 more). Returns the new SinglesendResponse.",
      "method": "POST",
      "path": "/v3/marketing/singlesends",
      "params": [
        {
          "name": "categories",
          "type": "array",
          "location": "body",
          "description": "The categories to associate with this Single Send."
        },
        {
          "name": "email_config",
          "type": "object",
          "location": "body",
          "description": "Email config"
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The name of the Single Send.",
          "required": true
        },
        {
          "name": "send_at",
          "type": "string",
          "location": "body",
          "description": "Set this property to an ISO 8601 formatted date-time when you would like to send the Single Send. Please note that any `send_at` property value set with this endpoint will prepopulate the send date in the SendGrid user interface (UI). However, the Single Send will remain an unscheduled draft until it's updated with the [**Schedule Single Send**](https://docs.sendgrid.com/api-reference/single-sends/schedule-single-send) endpoint or SendGrid application UI. Additionally, the `now` keyword is a valid `send_at` value only when using the Schedule Single Send endpoint. Setting this property to `now` with this endpoint will cause an error."
        },
        {
          "name": "send_to",
          "type": "object",
          "location": "body",
          "description": "Send to"
        }
      ]
    },
    {
      "name": "marketing_delete-contact",
      "description": "**This endpoint can be used to delete one or more contacts**. The query parameter `ids` must set to a comma-separated list of contact IDs for bulk contact deletion. The query parameter `delete_all_contacts` must be set to `'true'` to delete **all** contacts. You must set either `ids` or `delete_all_contacts`. Deletion jobs are processed asynchronously. Twilio SendGrid recommends exporting your contacts regularly as a backup to avoid issues or lost data. Optional: delete_all_contacts, ids. Returns the MarketingDeleteContactResponse. Destructive.",
      "method": "DELETE",
      "path": "/v3/marketing/contacts",
      "params": [
        {
          "name": "delete_all_contacts",
          "type": "string",
          "location": "query",
          "description": "Must be set to `'true'` to delete all contacts."
        },
        {
          "name": "ids",
          "type": "string",
          "location": "query",
          "description": "A comma-separated list of contact IDs."
        }
      ]
    },
    {
      "name": "marketing_delete-contact-identifier",
      "description": "**This endpoint can be used to delete one identifier from a contact.** Deletion jobs are processed asynchronously. Note this is different from deleting a contact. If the contact has only one identifier, the asynchronous request will fail. All contacts are required to have at least one identifier. The request body field `identifier_type` must have a valid value of 'EMAIL', 'PHONENUMBERID', 'EXTERNALID', or 'ANONYMOUSID'. Required: contact_id, identifier_type, identifier_value. Returns the MarketingDeleteContactIdentifierResponse. Destructive.",
      "method": "DELETE",
      "path": "/v3/marketing/contacts/{contact_id}/identifiers",
      "params": [
        {
          "name": "contact_id",
          "type": "string",
          "location": "path",
          "description": "Must be set to the `contact_id` of the contact you want to remove the identifier from.",
          "required": true
        },
        {
          "name": "identifier_type",
          "type": "string",
          "location": "body",
          "description": "The type of identifier you are removing from the contact.",
          "required": true
        },
        {
          "name": "identifier_value",
          "type": "string",
          "location": "body",
          "description": "The value of the identifier you want to remove from the contact.",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_delete-contact-lists",
      "description": "**This endpoint allows you to remove contacts from a given list.** The contacts will not be deleted. Only their list membership will be changed. Required: id, contact_ids. Returns the MarketingDeleteContactListsResponse. Destructive.",
      "method": "DELETE",
      "path": "/v3/marketing/lists/{id}/contacts",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the list on which you want to perform the operation.",
          "required": true
        },
        {
          "name": "contact_ids",
          "type": "string",
          "location": "query",
          "description": "Comma separated list of contact IDs that you want to remove from the specified contacts list.",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_delete-field-definition",
      "description": "**This endpoint deletes a defined Custom Field.** You can delete only Custom Fields; Reserved Fields cannot be deleted. Required: custom_field_id. Destructive.",
      "method": "DELETE",
      "path": "/v3/marketing/field_definitions/{custom_field_id}",
      "params": [
        {
          "name": "custom_field_id",
          "type": "string",
          "location": "path",
          "description": "Custom field id",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_delete-integration",
      "description": "This endpoint deletes Integrations. Required: ids. Destructive.",
      "method": "DELETE",
      "path": "/v3/marketing/integrations",
      "params": [
        {
          "name": "ids",
          "type": "array",
          "location": "query",
          "description": "Comma-delimited Integration IDs for the Integrations to delete.",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_delete-list",
      "description": "**This endpoint allows you to deletes a specific list.** Optionally, you can also delete contacts associated to the list. The query parameter, `delete_contacts=true`, will delete the list and start an asynchronous job to delete associated contacts. Required: id. Optional: delete_contacts (default: false). Returns the MarketingDeleteListResponse. Destructive.",
      "method": "DELETE",
      "path": "/v3/marketing/lists/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the list on which you want to perform the operation.",
          "required": true
        },
        {
          "name": "delete_contacts",
          "type": "bool",
          "location": "query",
          "description": "Flag indicates that all contacts on the list are also to be deleted."
        }
      ]
    },
    {
      "name": "marketing_delete-scheduled-single-send",
      "description": "**This endpoint allows you to cancel a scheduled Single Send using a Single Send ID.** Making a DELETE request to this endpoint will cancel the scheduled sending of a Single Send. The request will not delete the Single Send itself. Deleting a Single Send can be done by passing a DELETE request to `/marketing/singlesends/{id}`. Required: id. Returns the SinglesendSchedule. Destructive.",
      "method": "DELETE",
      "path": "/v3/marketing/singlesends/{id}/schedule",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_delete-segment",
      "description": "**This endpoint allows you to delete a segment by `segment_id`.** Note that deleting a segment does not delete the contacts associated with the segment by default. Contacts associated with a deleted segment will remain in your list of all contacts and any other segments they belong to. Required: segment_id. Returns the MarketingDeleteSegmentResponse. Destructive.",
      "method": "DELETE",
      "path": "/v3/marketing/segments/{segment_id}",
      "params": [
        {
          "name": "segment_id",
          "type": "string",
          "location": "path",
          "description": "Segment id",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_delete-segment-segments",
      "description": "**This endpoint allows you to delete a segment by ID.**. Required: segment_id. Destructive.",
      "method": "DELETE",
      "path": "/v3/marketing/segments/2.0/{segment_id}",
      "params": [
        {
          "name": "segment_id",
          "type": "string",
          "location": "path",
          "description": "Segment id",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_delete-sender",
      "description": "**This endpoint allows you to delete an existing Sender.**. Required: id. Destructive.",
      "method": "DELETE",
      "path": "/v3/marketing/senders/{id}",
      "params": [
        {
          "name": "id",
          "type": "int",
          "location": "path",
          "description": "The unique identifier of the Sender.",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_delete-single-send",
      "description": "**This endpoint allows you to delete one Single Send using a Single Send ID.** To first retrieve all your Single Sends' IDs, you can make a GET request to the `/marketing/singlensends` endpoint. Please note that a `DELETE` request is permanent, and your Single Send will not be recoverable after deletion. Required: id. Destructive.",
      "method": "DELETE",
      "path": "/v3/marketing/singlesends/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_delete-single-sends",
      "description": "**This endpoint allows you to delete multiple Single Sends using an array of Single Sends IDs.** To first retrieve all your Single Sends' IDs, you can make a GET request to the `/marketing/singlensends` endpoint. Please note that a DELETE request is permanent, and your Single Sends will not be recoverable after deletion. Optional: ids. Destructive.",
      "method": "DELETE",
      "path": "/v3/marketing/singlesends",
      "params": [
        {
          "name": "ids",
          "type": "array",
          "location": "query",
          "description": "Single Send IDs to delete"
        }
      ]
    },
    {
      "name": "marketing_duplicate-single-send",
      "description": "**This endpoint allows you to duplicate an existing Single Send using its Single Send ID.** Duplicating a Single Send is useful when you want to create a Single Send but don't want to start from scratch. Once duplicated, you can update or edit the Single Send by making a PATCH request to the `/marketing/singlesends/{id}` endpoint. If you leave the `name` field blank, your duplicate will be assigned the name of the Single Send it was copied from with the text “Copy of ” prepended to it. The `name` field length is limited to 100 characters, so the end of the new Single Send name, including “Copy of ”, will be trimmed if the name exceeds this limit. Required: id. Optional: name. Returns the new SinglesendResponse.",
      "method": "POST",
      "path": "/v3/marketing/singlesends/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The name of the duplicate Single Send. If you choose to leave the name field blank, your duplicate will be assigned the name of the Single Send it was copied from with the text 'Copy of ' prepended to it. The end of the new Single Send name, including 'Copy of ', will be trimmed if the name exceeds the character limit."
        }
      ]
    },
    {
      "name": "marketing_export-automation-stat",
      "description": "**This endpoint allows you to export Single Send stats as .CSV data**. You can specify one Single Send or many: include as many Single Send IDs as you need, separating them with commas, as the value of the `ids` query string parameter. The data is returned as plain text response but in .CSV format, so your application making the call can present the information in whatever way is most appropriate, or just save the data as a .csv file. Optional: ids, timezone (default: UTC).",
      "method": "GET",
      "path": "/v3/marketing/stats/automations/export",
      "params": [
        {
          "name": "ids",
          "type": "array",
          "location": "query",
          "description": "The IDs of Single Sends for which to export stats."
        },
        {
          "name": "timezone",
          "type": "string",
          "location": "query",
          "description": "The [IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_timezones) string representing the timezone in which the stats are to be presented; i.e. `'America/Chicago'`. This parameter changes the timezone format only; it does not alter which stats are returned."
        }
      ]
    },
    {
      "name": "marketing_export-contact",
      "description": "**Use this endpoint to export lists or segments of contacts**. If you would just like to have a link to the exported list sent to your email set the `notifications.email` option to `true` in the `POST` payload. If you would like to download the list, take the `id` that is returned and use the 'Export Contacts Status' endpoint to get the `urls`. Once you have the list of URLs, make a `GET` request to each URL provided to download your CSV file(s). You specify the segments and or/contact lists you wish to export by providing the relevant IDs in, respectively, the `segment_ids` and `list_ids` fields in the request body. The lists will be provided in either JSON or CSV files. To specify which of these you would required, set the request body `file_type` field to `json` or `csv`. You can also specify a maximum file size (in MB). If the export file is larger than this, it will be split into multiple files. Optional: file_type (default: csv), list_ids, max_file_size (default: 5000) (plus 2 more). Returns the new MarketingExportContactResponse.",
      "method": "POST",
      "path": "/v3/marketing/contacts/exports",
      "params": [
        {
          "name": "file_type",
          "type": "string",
          "location": "body",
          "description": "File type for export file. Choose from `json` or `csv`."
        },
        {
          "name": "list_ids",
          "type": "array",
          "location": "body",
          "description": "IDs of the contact lists you want to export."
        },
        {
          "name": "max_file_size",
          "type": "int",
          "location": "body",
          "description": "The maximum size of an export file in MB. Note that when this option is specified, multiple output files may be returned from the export."
        },
        {
          "name": "notifications",
          "type": "object",
          "location": "body",
          "description": "Notifications"
        },
        {
          "name": "segment_ids",
          "type": "array",
          "location": "body",
          "description": "IDs of the contact segments you want to export."
        }
      ]
    },
    {
      "name": "marketing_export-single-send-stat",
      "description": "**This endpoint allows you to export Single Send stats as .CSV data**. You can specify one Single Send or many: include as many Single Send IDs as you need, separating them with commas, as the value of the `ids` query string parameter. The data is returned as plain text response but in .CSV format, so your application making the call can present the information in whatever way is most appropriate, or just save the data as a .csv file. Optional: ids, timezone (default: UTC).",
      "method": "GET",
      "path": "/v3/marketing/stats/singlesends/export",
      "params": [
        {
          "name": "ids",
          "type": "array",
          "location": "query",
          "description": "The IDs of Single Sends for which to export stats."
        },
        {
          "name": "timezone",
          "type": "string",
          "location": "query",
          "description": "The [IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_timezones) string representing the timezone in which the stats are to be presented; i.e. `'America/Chicago'`. This parameter changes the timezone format only; it does not alter which stats are returned."
        }
      ]
    },
    {
      "name": "marketing_find-integration-by-id",
      "description": "This endpoint returns the data for a specific Integration. Required: id.",
      "method": "GET",
      "path": "/v3/marketing/integrations/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the Integration you would like to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_get-automation-stat",
      "description": "**This endpoint allows you to retrieve stats for a single Automation using its ID.** Multiple Automation IDs can be retrieved using the 'Get All Automation Stats' endpoint. Once you have an ID, this endpoint will return detailed stats for the single automation specified. You may constrain the stats returned using the `start_date` and `end_date` query string parameters. You can also use the `group_by` and `aggregated_by` query string parameters to further refine the stats returned. Required: id. Optional: group_by, step_ids, aggregated_by (default: total) (plus 5 more). Returns the AutomationsResponse.",
      "method": "GET",
      "path": "/v3/marketing/stats/automations/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the Automation for which you want to retrieve statistics.",
          "required": true
        },
        {
          "name": "group_by",
          "type": "array",
          "location": "query",
          "description": "Automations can have multiple steps. Including `step_id` as a `group_by` metric allows further granularity of stats."
        },
        {
          "name": "step_ids",
          "type": "array",
          "location": "query",
          "description": "Comma-separated list of `step_ids` that you want the link stats for."
        },
        {
          "name": "aggregated_by",
          "type": "string",
          "location": "query",
          "description": "Dictates how the stats are time-sliced. Currently, `'total'` and `'day'` are supported."
        },
        {
          "name": "start_date",
          "type": "string",
          "location": "query",
          "description": "Format: `YYYY-MM-DD`. If this parameter is included, the stats' start date is included in the search."
        },
        {
          "name": "end_date",
          "type": "string",
          "location": "query",
          "description": "Format: `YYYY-MM-DD`.If this parameter is included, the stats' end date is included in the search."
        },
        {
          "name": "timezone",
          "type": "string",
          "location": "query",
          "description": "[IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_timezones) string representing the timezone in which the stats are to be presented, e.g., 'America/Chicago'."
        },
        {
          "name": "page_size",
          "type": "int",
          "location": "query",
          "description": "The number of elements you want returned on each page."
        },
        {
          "name": "page_token",
          "type": "string",
          "location": "query",
          "description": "The stats endpoints are paginated."
        }
      ]
    },
    {
      "name": "marketing_get-contact",
      "description": "**This endpoint returns the full details and all fields for the specified contact**. The 'Get Contacts by Identifier' endpoint can be used to get the ID of a contact. Required: id.",
      "method": "GET",
      "path": "/v3/marketing/contacts/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_get-contact-by-identifiers",
      "description": "Use this endpoint to retrieve up to 100 contacts that match the requested identifier values for a single identifier type. `identifier_type` must be a valid identifier type: `email`, `phone_number_id`, `external_id`, or `anonymous_id`. Use this endpoint instead of the [Search Contacts endpoint](https://www.twilio.com/docs/sendgrid/api-reference/contacts/search-contacts) when you can provide exact identifiers and do not need to include other [Segmentation Query Language (SGQL)](https://www.twilio.com/docs/sendgrid/for-developers/sending-email/segmentation-query-language/) filters when searching. This endpoint returns a `200` status code when any contacts match the identifiers you supplied. When searching multiple identifier values in a single request, it is possible that some will match a contact while others will not. When a partially successful search like this is made, the matching contacts are returned in an object and an error message is returned for the identifier values that are not found. This endpoint returns a `404` status code when no contacts are found for the provided identifiers. This endpoint returns a `400` status code if any searched addresses are invalid. Twilio SendGrid recommends exporting your contacts regularly as a backup to avoid issues or lost data. Required: identifier_type (default: email), identifiers.",
      "method": "POST",
      "path": "/v3/marketing/contacts/search/identifiers/{identifier_type}",
      "params": [
        {
          "name": "identifier_type",
          "type": "string",
          "location": "path",
          "description": "The type of identifier to search for. You can use only one type of identifier per search."
        },
        {
          "name": "identifiers",
          "type": "array",
          "location": "body",
          "description": "One or more more identifier values of the given identifier type to search for in your Marketing Campaigns contacts.",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_get-export-contact",
      "description": "**This endpoint can be used to check the status of a contact export job**. To use this call, you will need the `id` from the 'Export Contacts' call. If you would like to download a list, take the `id` that is returned from the 'Export Contacts' endpoint and make an API request here to get the `urls`. Once you have the list of URLs, make a `GET` request on each URL to download your CSV file(s). Twilio SendGrid recommends exporting your contacts regularly as a backup to avoid issues or lost data. Required: id. Returns the ContactExport.",
      "method": "GET",
      "path": "/v3/marketing/contacts/exports/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_get-import-contact",
      "description": "**This endpoint can be used to check the status of a contact import job**. Use the `job_id` from the 'Import Contacts,' 'Add or Update a Contact,' or 'Delete Contacts' endpoints as the `id` in the path parameter. If there is an error with your `PUT` request, download the `errors_url` file and open it to view more details. The job `status` field indicates whether the job is `pending`, `completed`, `errored`, or `failed`. Pending means not started. Completed means finished without any errors. Errored means finished with some errors. Failed means finished with all errors, or the job was entirely unprocessable: for example, if you attempt to import file format we do not support. The `results` object will have fields depending on the job type. Twilio SendGrid recommends exporting your contacts regularly as a backup to avoid issues or lost data. Required: id. Returns the ContactImport.",
      "method": "GET",
      "path": "/v3/marketing/contacts/imports/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_get-integrations-by-user",
      "description": "This endpoint returns all the Integrations for the user making this call.",
      "method": "GET",
      "path": "/v3/marketing/integrations",
      "params": []
    },
    {
      "name": "marketing_get-list",
      "description": "**This endpoint returns data about a specific list.** Setting the optional parameter `contact_sample=true` returns the `contact_sample` in the response body. Up to 50 of the most recent contacts uploaded or attached to a list will be returned. The full contact count is also returned. Required: id. Optional: contact_sample (default: false).",
      "method": "GET",
      "path": "/v3/marketing/lists/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the list on which you want to perform the operation.",
          "required": true
        },
        {
          "name": "contact_sample",
          "type": "bool",
          "location": "query",
          "description": "Setting this parameter to the true will cause the contact_sample to be returned"
        }
      ]
    },
    {
      "name": "marketing_get-segment",
      "description": "**This endpoint allows you to retrieve a single segment by ID.**. Required: segment_id. Optional: query_json. Returns the FullSegment.",
      "method": "GET",
      "path": "/v3/marketing/segments/{segment_id}",
      "params": [
        {
          "name": "segment_id",
          "type": "string",
          "location": "path",
          "description": "Segment id",
          "required": true
        },
        {
          "name": "query_json",
          "type": "bool",
          "location": "query",
          "description": "Defaults to `false`. Set to `true` to return the parsed SQL AST as a JSON object in the field `query_json`"
        }
      ]
    },
    {
      "name": "marketing_get-segment-segments",
      "description": "Get Marketing Campaigns Segment by ID. Required: segment_id. Optional: contacts_sample. Returns the Segment2xx.",
      "method": "GET",
      "path": "/v3/marketing/segments/2.0/{segment_id}",
      "params": [
        {
          "name": "segment_id",
          "type": "string",
          "location": "path",
          "description": "Segment id",
          "required": true
        },
        {
          "name": "contacts_sample",
          "type": "bool",
          "location": "query",
          "description": "Defaults to `true`. Set to `false` to exclude the contacts_sample in the response."
        }
      ]
    },
    {
      "name": "marketing_get-sender",
      "description": "**This endpoint allows you to get the details for a specific Sender by `id`.**. Required: id. Returns the Sender.",
      "method": "GET",
      "path": "/v3/marketing/senders/{id}",
      "params": [
        {
          "name": "id",
          "type": "int",
          "location": "path",
          "description": "The unique identifier of the Sender.",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_get-single-send",
      "description": "**This endpoint allows you to retrieve details about one Single Send using a Single Send ID.** You can retrieve all of your Single Sends by making a GET request to the `/marketing/singlesends` endpoint. Required: id. Returns the SinglesendResponse.",
      "method": "GET",
      "path": "/v3/marketing/singlesends/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_get-single-send-stat",
      "description": "**This endpoint allows you to retrieve stats for an individual Single Send using a Single Send ID.** Multiple Single Send IDs can be retrieved using the 'Get All Single Sends Stats' endpoint. Once you have an ID, this endpoint will return detailed stats for the Single Send specified. You may constrain the stats returned using the `start_date` and `end_date` query string parameters. You can also use the `group_by` and `aggregated_by` query string parameters to further refine the stats returned. Required: id. Optional: aggregated_by (default: total), start_date (default: 2021-01-01), end_date (default: 2021-12-31) (plus 4 more). Returns the SinglesendsResponse.",
      "method": "GET",
      "path": "/v3/marketing/stats/singlesends/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of Single Send for which you want to retrieve stats.",
          "required": true
        },
        {
          "name": "aggregated_by",
          "type": "string",
          "location": "query",
          "description": "Dictates how the stats are time-sliced. Currently, `'total'` and `'day'` are supported."
        },
        {
          "name": "start_date",
          "type": "string",
          "location": "query",
          "description": "Format: `YYYY-MM-DD`. If this parameter is included, the stats' start date is included in the search."
        },
        {
          "name": "end_date",
          "type": "string",
          "location": "query",
          "description": "Format: `YYYY-MM-DD`.If this parameter is included, the stats' end date is included in the search."
        },
        {
          "name": "timezone",
          "type": "string",
          "location": "query",
          "description": "[IANA Area/Region](https://en.wikipedia.org/wiki/Tz_database#Names_of_timezones) string representing the timezone in which the stats are to be presented, e.g., 'America/Chicago'."
        },
        {
          "name": "page_size",
          "type": "int",
          "location": "query",
          "description": "The number of elements you want returned on each page."
        },
        {
          "name": "page_token",
          "type": "string",
          "location": "query",
          "description": "The stats endpoints are paginated."
        },
        {
          "name": "group_by",
          "type": "array",
          "location": "query",
          "description": "A/B Single Sends have multiple variation IDs and phase IDs. Including these additional fields allows further granularity of stats by these fields."
        }
      ]
    },
    {
      "name": "marketing_import-contact",
      "description": "**This endpoint allows a CSV upload containing up to one million contacts or 5GB of data, whichever is smaller. At least one identifier is required for a successful import.** Imports take place asynchronously: the endpoint returns a URL (`upload_uri`) and HTTP headers (`upload_headers`) which can subsequently be used to `PUT` a file of contacts to be imported into our system. Uploaded CSV files may also be [gzip-compressed](https://en.wikipedia.org/wiki/Gzip). In either case, you must include the field `file_type` with the value `csv` in your request body. The `field_mappings` parameter is a respective list of field definition IDs to map the uploaded CSV columns to. It allows you to use CSVs where one or more columns are skipped (`null`) or remapped to the contact field. For example, if `field_mappings` is set to `[null, 'w1', '_rf1']`, this means skip column 0, map column 1 to the custom field with the ID `w1`, and map column 2 to the reserved field with the ID `_rf1`. See the 'Get All Field Definitions' endpoint to fetch your custom and reserved field IDs to use with `field_mappings`. Once you receive the response body you can then initiate a **second** API call where you use the supplied URL and HTTP header to upload your file. For example: `curl --upload-file 'file/path.csv' 'URL_GIVEN' -H 'HEADER_GIVEN'` If you would like to monitor the status of your import job, use the `job_id` and the 'Import Contacts Status' endpoint. Twilio SendGrid recommends exporting your contacts regularly as a backup to avoid issues or lost data. Required: field_mappings, file_type. Optional: list_ids.",
      "method": "PUT",
      "path": "/v3/marketing/contacts/imports",
      "params": [
        {
          "name": "field_mappings",
          "type": "array",
          "location": "body",
          "description": "Import file header to reserved/custom field mapping.",
          "required": true
        },
        {
          "name": "file_type",
          "type": "string",
          "location": "body",
          "description": "Upload file type.",
          "required": true
        },
        {
          "name": "list_ids",
          "type": "array",
          "location": "body",
          "description": "All contacts will be added to each of the specified lists."
        }
      ]
    },
    {
      "name": "marketing_list-automation-stat",
      "description": "**This endpoint allows you to retrieve stats for all your Automations.** By default, all of your Automations will be returned, but you can specify a selection by passing in a comma-separated list of Automation IDs as the value of the query string parameter `automation_ids`. Responses are paginated. You can limit the number of responses returned per batch using the `page_size` query string parameter. The default is 25, but you can specify a value between 1 and 50. You can retrieve a specific page of responses with the `page_token` query string parameter. Optional: automation_ids, page_size (default: 25), page_token. Returns the AutomationsResponse.",
      "method": "GET",
      "path": "/v3/marketing/stats/automations",
      "params": [
        {
          "name": "automation_ids",
          "type": "array",
          "location": "query",
          "description": "This endpoint returns all automation IDs if no `automation_ids` are specified."
        },
        {
          "name": "page_size",
          "type": "int",
          "location": "query",
          "description": "The number of elements you want returned on each page."
        },
        {
          "name": "page_token",
          "type": "string",
          "location": "query",
          "description": "The stats endpoints are paginated."
        }
      ]
    },
    {
      "name": "marketing_list-batched-contact",
      "description": "**This endpoint is used to retrieve a set of contacts identified by their IDs.** This can be more efficient endpoint to get contacts than making a series of individual `GET` requests to the 'Get a Contact by ID' endpoint. You can supply up to 100 IDs. Pass them into the `ids` field in your request body as an array or one or more strings. Twilio SendGrid recommends exporting your contacts regularly as a backup to avoid issues or lost data. Required: ids. Returns the new MarketingListBatchedContactResponse.",
      "method": "POST",
      "path": "/v3/marketing/contacts/batch",
      "params": [
        {
          "name": "ids",
          "type": "array",
          "location": "body",
          "description": "Ids",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_list-category",
      "description": "**This endpoint allows you to retrieve all the categories associated with your Single Sends.** This endpoint will return your latest 1,000 categories. Returns the MarketingListCategoryResponse.",
      "method": "GET",
      "path": "/v3/marketing/singlesends/categories",
      "params": []
    },
    {
      "name": "marketing_list-click-tracking-stat",
      "description": "**This endpoint lets you retrieve click-tracking stats for a single Automation**. The stats returned list the URLs embedded in your Automation and the number of clicks each one received. Required: id. Optional: group_by, step_ids, page_size (default: 25) (plus 1 more). Returns the AutmoationsLinkStatsResponse.",
      "method": "GET",
      "path": "/v3/marketing/stats/automations/{id}/links",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the Automation you want to get click tracking stats for.",
          "required": true
        },
        {
          "name": "group_by",
          "type": "array",
          "location": "query",
          "description": "Automations can have multiple steps. Including `step_id` as a `group_by` metric allows further granularity of stats."
        },
        {
          "name": "step_ids",
          "type": "array",
          "location": "query",
          "description": "Comma-separated list of `step_ids` that you want the link stats for."
        },
        {
          "name": "page_size",
          "type": "int",
          "location": "query",
          "description": "The number of elements you want returned on each page."
        },
        {
          "name": "page_token",
          "type": "string",
          "location": "query",
          "description": "The stats endpoints are paginated."
        }
      ]
    },
    {
      "name": "marketing_list-contact",
      "description": "**This endpoint will return up to 50 of the most recent contacts uploaded or attached to a list**. This list will then be sorted by email address. The full contact count is also returned. Please note that pagination of the contacts has been deprecated. Twilio SendGrid recommends exporting your contacts regularly as a backup to avoid issues or lost data. Returns the MarketingListContactResponse.",
      "method": "GET",
      "path": "/v3/marketing/contacts",
      "params": []
    },
    {
      "name": "marketing_list-contact-by-email",
      "description": "**This endpoint allows you to retrieve up to 100 contacts matching the searched `email` address(es), including any `alternate_emails`.** Email addresses are unique to a contact, meaning this endpoint can treat an email address as a primary key to search by. The contact object associated with the address, whether it is their `email` or one of their `alternate_emails` will be returned if matched. Email addresses in the search request do not need to match the case in which they're stored, but the email addresses in the result will be all lower case. Empty strings are excluded from the search and will not be returned. This endpoint should be used in place of the 'Search Contacts' endpoint when you can provide exact email addresses and do not need to include other [Segmentation Query Language (SGQL)](https://sendgrid.com/docs/for-developers/sending-email/segmentation-query-language/) filters when searching. If you need to access a large percentage of your contacts, we recommend exporting your contacts with the 'Export Contacts' endpoint and filtering the client side results. This endpoint returns a `200` status code when any contacts match the address(es) you supplied. When searching multiple addresses in a single request, it is possible that some addresses will match a contact while others will not. When a partially successful search like this is made, the matching contacts are returned in an object and an error message is returned for the email address(es) that are not found. This endpoint returns a `404` status code when no contacts are found for the provided email address(es). A `400` status code is returned if any searched addresses are invalid. Twilio SendGrid recommends exporting your contacts regularly as a backup to avoid issues or lost data. Required: emails. Optional: anonymous_id, external_id, phone_number_id.",
      "method": "POST",
      "path": "/v3/marketing/contacts/search/emails",
      "params": [
        {
          "name": "anonymous_id",
          "type": "string",
          "location": "body",
          "description": "The contact's Anonymous ID."
        },
        {
          "name": "emails",
          "type": "array",
          "location": "body",
          "description": "One or more primary and/or alternate email addresses to search for in your Marketing Campaigns contacts.",
          "required": true
        },
        {
          "name": "external_id",
          "type": "string",
          "location": "body",
          "description": "The contact's External ID."
        },
        {
          "name": "phone_number_id",
          "type": "string",
          "location": "body",
          "description": "The contact's Phone Number ID. This is required to be a valid phone number."
        }
      ]
    },
    {
      "name": "marketing_list-contact-count",
      "description": "**This endpoint returns the total number of contacts you have stored.** Twilio SendGrid recommends exporting your contacts regularly as a backup to avoid issues or lost data.",
      "method": "GET",
      "path": "/v3/marketing/contacts/count",
      "params": []
    },
    {
      "name": "marketing_list-contact-count-lists",
      "description": "**This endpoint returns the number of contacts on a specific list.**. Required: id.",
      "method": "GET",
      "path": "/v3/marketing/lists/{id}/contacts/count",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_list-export-contact",
      "description": "**Use this endpoint to retrieve details of all current exported jobs**. It will return an array of objects, each of which records an export job in flight or recently completed. Each object's `export_type` field will tell you which kind of export it is and its `status` field will indicate what stage of processing it has reached. Exports which are `ready` will be accompanied by a `urls` field which lists the URLs of the export's downloadable files — there will be more than one if you specified a maximum file size in your initial export request. Use this endpoint if you have exports in flight but do not know their IDs, which are required for the 'Export Contacts Status' endpoint. Returns the MarketingListExportContactResponse.",
      "method": "GET",
      "path": "/v3/marketing/contacts/exports",
      "params": []
    },
    {
      "name": "marketing_list-field-definition",
      "description": "**This endpoint retrieves all defined Custom Fields and Reserved Fields.**. Returns the MarketingListFieldDefinitionResponse.",
      "method": "GET",
      "path": "/v3/marketing/field_definitions",
      "params": []
    },
    {
      "name": "marketing_list-list",
      "description": "**This endpoint returns an array of all of your contact lists.**. Optional: page_size (default: 100), page_token.",
      "method": "GET",
      "path": "/v3/marketing/lists",
      "params": [
        {
          "name": "page_size",
          "type": "float",
          "location": "query",
          "description": "Maximum number of elements to return. Defaults to 100, returns 1000 max"
        },
        {
          "name": "page_token",
          "type": "string",
          "location": "query",
          "description": "Page token"
        }
      ]
    },
    {
      "name": "marketing_list-segment",
      "description": "**This endpoint allows you to retrieve a list of segments.** The query param `parent_list_ids` is treated as a filter. Any match will be returned. Zero matches will return a response code of 200 with an empty `results` array. `parent_list_ids` | `no_parent_list_id` | `ids` | `result` -----------------:|:--------------------:|:-------------:|:-------------: empty | false | empty | all segments values list_ids | false | empty | segments filtered by list_ids values list_ids |true | empty | segments filtered by list_ids and segments with no parent list_ids empty empty | true | empty | segments with no parent list_ids anything | anything | ids | segments with matching segment ids |. Optional: ids, parent_list_ids, no_parent_list_id (default: false). Returns the MarketingListSegmentResponse.",
      "method": "GET",
      "path": "/v3/marketing/segments",
      "params": [
        {
          "name": "ids",
          "type": "array",
          "location": "query",
          "description": "A list of segment IDs to retrieve. When this parameter is included, the `no_parent_list_ids` and `parent_list_ids` parameters are ignored and only segments with given IDs are returned."
        },
        {
          "name": "parent_list_ids",
          "type": "string",
          "location": "query",
          "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",
          "type": "bool",
          "location": "query",
          "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 to 'false'."
        }
      ]
    },
    {
      "name": "marketing_list-segment-segments",
      "description": "**This endpoint allows you to retrieve a list of segments.** The query param `parent_list_ids` is treated as a filter. Any match will be returned. Zero matches will return a response code of 200 with an empty `results` array. `parent_list_ids` | `no_parent_list_id` | `ids` | `result` -----------------:|:--------------------:|:-------------:|:-------------: empty | false | empty | all segments values list_ids | false | empty | segments filtered by list_ids values list_ids |true | empty | segments filtered by list_ids and segments with no parent list_ids empty empty | true | empty | segments with no parent list_ids anything | anything | ids | segments with matching segment ids |. Optional: ids, parent_list_ids, no_parent_list_id (default: false). Returns the AllSegments200.",
      "method": "GET",
      "path": "/v3/marketing/segments/2.0",
      "params": [
        {
          "name": "ids",
          "type": "array",
          "location": "query",
          "description": "A list of segment IDs to retrieve. When this parameter is included, the `no_parent_list_ids` and `parent_list_ids` parameters are ignored and only segments with given IDs are returned."
        },
        {
          "name": "parent_list_ids",
          "type": "string",
          "location": "query",
          "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 retrieved. This is different from the parameter of the same name used when creating a segment."
        },
        {
          "name": "no_parent_list_id",
          "type": "bool",
          "location": "query",
          "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 to 'false'."
        }
      ]
    },
    {
      "name": "marketing_list-sender",
      "description": "**This endpoint allows you to get a list of all your Senders.**. Returns the MarketingListSenderResponse.",
      "method": "GET",
      "path": "/v3/marketing/senders",
      "params": []
    },
    {
      "name": "marketing_list-single-send",
      "description": "**This endpoint allows you to retrieve all your Single Sends.** Returns all of your Single Sends with condensed details about each, including the Single Sends' IDs. For more details about an individual Single Send, pass the Single Send's ID to the `/marketing/singlesends/{id}` endpoint. Optional: page_size, page_token.",
      "method": "GET",
      "path": "/v3/marketing/singlesends",
      "params": [
        {
          "name": "page_size",
          "type": "int",
          "location": "query",
          "description": "Page size"
        },
        {
          "name": "page_token",
          "type": "string",
          "location": "query",
          "description": "Page token"
        }
      ]
    },
    {
      "name": "marketing_list-single-send-stat",
      "description": "**This endpoint allows you to retrieve stats for all your Single Sends.** By default, all of your Single Sends will be returned, but you can specify a selection by passing in a comma-separated list of Single Send IDs as the value of the query string parameter `singlesend_ids`. Responses are paginated. You can limit the number of responses returned per batch using the `page_size` query string parameter. The default is 25, but you specify a value between 1 and 50. You can retrieve a specific page of responses with the `page_token` query string parameter. Optional: singlesend_ids, page_size (default: 25), page_token. Returns the SinglesendsResponse.",
      "method": "GET",
      "path": "/v3/marketing/stats/singlesends",
      "params": [
        {
          "name": "singlesend_ids",
          "type": "array",
          "location": "query",
          "description": "This endpoint returns all Single Send IDs if no IDs are included in `singlesend_ids`."
        },
        {
          "name": "page_size",
          "type": "int",
          "location": "query",
          "description": "The number of elements you want returned on each page."
        },
        {
          "name": "page_token",
          "type": "string",
          "location": "query",
          "description": "The stats endpoints are paginated."
        }
      ]
    },
    {
      "name": "marketing_list-single-send-tracking-stat",
      "description": "**This endpoint lets you retrieve click-tracking stats for one Single Send**. The stats returned list the URLs embedded in the specified Single Send and the number of clicks each one received. Required: id. Optional: page_size (default: 25), page_token, group_by (plus 2 more). Returns the SinglesendsLinkStatsResponse.",
      "method": "GET",
      "path": "/v3/marketing/stats/singlesends/{id}/links",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of Single Send for which you want to retrieve link stats.",
          "required": true
        },
        {
          "name": "page_size",
          "type": "int",
          "location": "query",
          "description": "The number of elements you want returned on each page."
        },
        {
          "name": "page_token",
          "type": "string",
          "location": "query",
          "description": "The stats endpoints are paginated."
        },
        {
          "name": "group_by",
          "type": "array",
          "location": "query",
          "description": "A/B Single Sends have multiple variation IDs and phase IDs. Including these additional fields allows further granularity of stats by these fields."
        },
        {
          "name": "ab_variation_id",
          "type": "string",
          "location": "query",
          "description": "Ab variation id"
        },
        {
          "name": "ab_phase_id",
          "type": "string",
          "location": "query",
          "description": "Ab phase id"
        }
      ]
    },
    {
      "name": "marketing_refresh-segment",
      "description": "Manually refresh a segment by segment ID. Required: segment_id, user_time_zone. Returns the new SegmentRefresh202.",
      "method": "POST",
      "path": "/v3/marketing/segments/2.0/refresh/{segment_id}",
      "params": [
        {
          "name": "segment_id",
          "type": "string",
          "location": "path",
          "description": "Segment id",
          "required": true
        },
        {
          "name": "user_time_zone",
          "type": "string",
          "location": "body",
          "description": "The user's timezone. The timezone is used to reset the refresh count at midnight in the user's local time. Only [IANA time zone format](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) is accepted.",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_reset-sender-verification",
      "description": "**This endpoint allows you to resend the verification request for a specific Sender.**. Required: id.",
      "method": "POST",
      "path": "/v3/marketing/senders/{id}/resend_verification",
      "params": [
        {
          "name": "id",
          "type": "int",
          "location": "path",
          "description": "The unique identifier of the Sender.",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_schedule-single-send",
      "description": "**This endpoint allows you to send a Single Send immediately or schedule it to be sent at a later time.** To send your message immediately, set the `send_at` property value to the string `now`. To schedule the Single Send for future delivery, set the `send_at` value to your desired send time in [ISO 8601 date time format](https://www.iso.org/iso-8601-date-and-time-format.html) (`yyyy-MM-ddTHH:mm:ssZ`). Required: id, send_at. Returns the updated MarketingScheduleSingleSendResponse.",
      "method": "PUT",
      "path": "/v3/marketing/singlesends/{id}/schedule",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        },
        {
          "name": "send_at",
          "type": "string",
          "location": "body",
          "description": "The ISO 8601 time at which to send the Single Send. This must be in future or the string `now`. SendGrid [Mail Send](https://docs.sendgrid.com/api-reference/mail-send/mail-send) emails can be scheduled up to 72 hours in advance. However, this scheduling constraint does not apply to emails sent via [Marketing Campaigns](https://docs.sendgrid.com/ui/sending-email/how-to-send-email-with-marketing-campaigns/).",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_search-contact",
      "description": "**Use this endpoint to locate contacts**. The request body's `query` field accepts valid [SGQL](https://sendgrid.com/docs/for-developers/sending-email/segmentation-query-language/) for searching for a contact. Because contact emails are stored in lower case, using SGQL to search by email address requires the provided email address to be in lower case. The SGQL `lower()` function can be used for this. Only the first 50 contacts that meet the search criteria will be returned. If the query takes longer than 20 seconds, a `408 Request Timeout` status will be returned. Formatting the `created_at` and `updated_at` values as Unix timestamps is deprecated. Instead, they are returned as ISO format as string. Required: query. Returns the new MarketingSearchContactResponse.",
      "method": "POST",
      "path": "/v3/marketing/contacts/search",
      "params": [
        {
          "name": "query",
          "type": "string",
          "location": "body",
          "description": "An SGQL search string or other pattern.",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_search-single-send",
      "description": "**This endpoint allows you to search for Single Sends based on specified criteria.** You can search for Single Sends by passing a combination of values using the `name`, `status`, and `categories` request body fields. For example, if you want to search for all Single Sends that are 'drafts' or 'scheduled' and also associated with the category 'shoes,' your request body may look like the example below. ```javascript { 'status': [ 'draft', 'scheduled' ], 'categories': [ 'shoes' ], } ```. Optional: page_size, page_token, categories (plus 2 more). Returns the new MarketingSearchSingleSendResponse.",
      "method": "POST",
      "path": "/v3/marketing/singlesends/search",
      "params": [
        {
          "name": "page_size",
          "type": "int",
          "location": "query",
          "description": "Page size"
        },
        {
          "name": "page_token",
          "type": "string",
          "location": "query",
          "description": "Page token"
        },
        {
          "name": "categories",
          "type": "array",
          "location": "body",
          "description": "categories to associate with this Single Send, match any single send that has at least one of the categories"
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "leading and trailing wildcard search on name of the Single Send"
        },
        {
          "name": "status",
          "type": "array",
          "location": "body",
          "description": "current status of the Single Send"
        }
      ]
    },
    {
      "name": "marketing_send-test-email",
      "description": "**This endpoint allows you to send a test marketing email to a list of email addresses**. Before sending a marketing message, you can test it using this endpoint. You may specify up to **10 contacts** in the `emails` request body field. You must also specify a `template_id` and include either a `from_address` or `sender_id`. You can manage your templates with the [Twilio SendGrid App](https://mc.sendgrid.com/dynamic-templates) or the [Transactional Templates API](https://docs.sendgrid.com/api-reference/transactional-templates). \u003e Please note that this endpoint works with Dynamic Transactional Templates only. Legacy Transactional Templates will not be delivered. For more information about managing Dynamic Transactional Templates, see [How to Send Email with Dynamic Transactional Templates](https://sendgrid.com/docs/ui/sending-email/how-to-send-an-email-with-dynamic-transactional-templates/). You can also test your Single Sends in the [Twilio SendGrid Marketing Campaigns UI](https://mc.sendgrid.com/single-sends). Required: emails, template_id. Optional: custom_unsubscribe_url, from_address, sender_id (plus 2 more). Returns the new MarketingSendTestEmailResponse.",
      "method": "POST",
      "path": "/v3/marketing/test/send_email",
      "params": [
        {
          "name": "custom_unsubscribe_url",
          "type": "string",
          "location": "body",
          "description": "A custom unsubscribe URL."
        },
        {
          "name": "emails",
          "type": "array",
          "location": "body",
          "description": "An array of email addresses you want to send the test message to.",
          "required": true
        },
        {
          "name": "from_address",
          "type": "string",
          "location": "body",
          "description": "You can either specify this address or specify a verified sender ID."
        },
        {
          "name": "sender_id",
          "type": "int",
          "location": "body",
          "description": "This ID must belong to a verified sender. Alternatively, you may supply a `from_address` email."
        },
        {
          "name": "suppression_group_id",
          "type": "int",
          "location": "body",
          "description": "Suppression group id"
        },
        {
          "name": "template_id",
          "type": "string",
          "location": "body",
          "description": "The ID of the template that you would like to use. If you use a template that contains a subject and content (either text or HTML), then those values specified at the personalizations or message level will not be used.",
          "required": true
        },
        {
          "name": "version_id_override",
          "type": "string",
          "location": "body",
          "description": "You can override the active template with an alternative template version by passing the version ID in this field. If this field is blank, the active template version will be used."
        }
      ]
    },
    {
      "name": "marketing_update-contact",
      "description": "**This endpoint allows the [upsert](https://en.wiktionary.org/wiki/upsert) (insert or update) of up to 30,000 contacts, or 6MB of data, whichever is lower**. Because the creation and update of contacts is an asynchronous process, the response will not contain immediate feedback on the processing of your upserted contacts. Rather, it will contain an HTTP 202 response indicating the contacts are queued for processing or an HTTP 4XX error containing validation errors. Should you wish to get the resulting contact's ID or confirm that your contacts have been updated or added, you can use the [Get Contacts by Identifiers operation](https://www.twilio.com/docs/sendgrid/api-reference/contacts/get-contacts-by-identifiers). Please note that custom fields need to have been already created if you wish to set their values for the contacts being upserted. To do this, please use the [Create Custom Field Definition endpoint](https://www.twilio.com/docs/sendgrid/api-reference/custom-fields/create-custom-field-definition). You will see a `job_id` in the response to your request. This can be used to check the status of your upsert job. To do so, please use the [Import Contacts Status endpoint](https://www.twilio.com/docs/sendgrid/api-reference/contacts/import-contacts-status). If the contact already exists in the system, any entries submitted via this endpoint will update the existing contact. In order to update a contact, all of its existing identifiers must be present. Any fields omitted from the request will remain as they were. A contact's ID cannot be used to update the contact. The email field will be changed to all lower-case. If a contact is added with an email that exists but contains capital letters, the existing contact with the all lower-case email will be updated. Required: contacts. Optional: list_ids. Returns the updated MarketingUpdateContactResponse.",
      "method": "PUT",
      "path": "/v3/marketing/contacts",
      "params": [
        {
          "name": "contacts",
          "type": "array",
          "location": "body",
          "description": "One or more contacts objects that you intend to upsert. Each contact needs to include at least one of `email`, `phone_number_id`, `external_id`, or `anonymous_id` as an identifier.",
          "required": true
        },
        {
          "name": "list_ids",
          "type": "array",
          "location": "body",
          "description": "An array of List ID strings that this contact will be added to."
        }
      ]
    },
    {
      "name": "marketing_update-field-definition",
      "description": "**This endpoint allows you to update a defined Custom Field.** Only your Custom fields can be modified; Reserved Fields cannot be updated. Required: custom_field_id, name. Returns the updated MarketingUpdateFieldDefinitionResponse.",
      "method": "PATCH",
      "path": "/v3/marketing/field_definitions/{custom_field_id}",
      "params": [
        {
          "name": "custom_field_id",
          "type": "string",
          "location": "path",
          "description": "Custom field id",
          "required": true
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "Name",
          "required": true
        }
      ]
    },
    {
      "name": "marketing_update-integration",
      "description": "This endpoint updates an existing Integration. Required: id. Optional: destination, filters, label (default: Untitled Integration) (plus 1 more). Returns the updated Integration.",
      "method": "PATCH",
      "path": "/v3/marketing/integrations/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the Integration you would like to update.",
          "required": true
        },
        {
          "name": "destination",
          "type": "string",
          "location": "body",
          "description": "The third-party application you would like to forward your email events to."
        },
        {
          "name": "filters",
          "type": "object",
          "location": "body",
          "description": "The configurable filters for SendGrid to destination email event forwarding."
        },
        {
          "name": "label",
          "type": "string",
          "location": "body",
          "description": "The nickname for the Integration."
        },
        {
          "name": "properties",
          "type": "object",
          "location": "body",
          "description": "The properties of an Integration required to send events to a specific third-party application."
        }
      ]
    },
    {
      "name": "marketing_update-list",
      "description": "**This endpoint updates the name of a list.**. Required: id. Optional: name. Returns the updated List.",
      "method": "PATCH",
      "path": "/v3/marketing/lists/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the list on which you want to perform the operation.",
          "required": true
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "Your name for your list."
        }
      ]
    },
    {
      "name": "marketing_update-segment",
      "description": "Segment `name` has to be unique. A user can not create a new segment with an existing segment name. Required: segment_id. Optional: name, query_dsl. Returns the updated Segment2xx.",
      "method": "PATCH",
      "path": "/v3/marketing/segments/2.0/{segment_id}",
      "params": [
        {
          "name": "segment_id",
          "type": "string",
          "location": "path",
          "description": "Segment id",
          "required": true
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "Name of the segment."
        },
        {
          "name": "query_dsl",
          "type": "string",
          "location": "body",
          "description": "SQL query which will filter contacts based on the conditions provided"
        }
      ]
    },
    {
      "name": "marketing_update-sender",
      "description": "**This endpoint allows you to update an existing Sender.** Updates to `from.email` require re-verification. If your domain has been authenticated, a new Sender will auto verify on creation. Otherwise, an email will be sent to the `from.email`. Partial updates are allowed, but fields that are marked as 'required' in the `POST` (create) endpoint must not be nil if that field is included in the `PATCH` request. Required: id. Optional: address, address_2, city (plus 6 more). Returns the updated Sender.",
      "method": "PATCH",
      "path": "/v3/marketing/senders/{id}",
      "params": [
        {
          "name": "id",
          "type": "int",
          "location": "path",
          "description": "The unique identifier of the Sender.",
          "required": true
        },
        {
          "name": "address",
          "type": "string",
          "location": "body",
          "description": "The physical address of the Sender."
        },
        {
          "name": "address_2",
          "type": "string",
          "location": "body",
          "description": "Additional Sender address information."
        },
        {
          "name": "city",
          "type": "string",
          "location": "body",
          "description": "The city of the Sender."
        },
        {
          "name": "country",
          "type": "string",
          "location": "body",
          "description": "The country of the Sender."
        },
        {
          "name": "from",
          "type": "object",
          "location": "body",
          "description": "From"
        },
        {
          "name": "nickname",
          "type": "string",
          "location": "body",
          "description": "A nickname for the Sender. Not used for sending."
        },
        {
          "name": "reply_to",
          "type": "object",
          "location": "body",
          "description": "Reply to"
        },
        {
          "name": "state",
          "type": "string",
          "location": "body",
          "description": "The state of the Sender."
        },
        {
          "name": "zip",
          "type": "string",
          "location": "body",
          "description": "The zipcode of the Sender."
        }
      ]
    },
    {
      "name": "marketing_update-single-send",
      "description": "**This endpoint allows you to update a Single Send using a Single Send ID.** You only need to pass the properties you want to update. Any blank or missing properties will remain unaltered. This endpoint will update a draft of the Single Send but will not send it or schedule it to be sent. Any `send_at` property value set with this endpoint will prepopulate the Single Send's send date. However, the Single Send will remain an unscheduled draft until it's updated with the [**Schedule Single Send**](https://docs.sendgrid.com/api-reference/single-sends/schedule-single-send) endpoint or SendGrid application UI. Required: id, name. Optional: categories, email_config, send_at (plus 1 more). Returns the updated SinglesendResponse.",
      "method": "PATCH",
      "path": "/v3/marketing/singlesends/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        },
        {
          "name": "categories",
          "type": "array",
          "location": "body",
          "description": "The categories to associate with this Single Send."
        },
        {
          "name": "email_config",
          "type": "object",
          "location": "body",
          "description": "Email config"
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The name of the Single Send.",
          "required": true
        },
        {
          "name": "send_at",
          "type": "string",
          "location": "body",
          "description": "Set this property to an ISO 8601 formatted date-time when you would like to send the Single Send. Please note that any `send_at` property value set with this endpoint will prepopulate the send date in the SendGrid user interface (UI). However, the Single Send will remain an unscheduled draft until it's updated with the [**Schedule Single Send**](https://docs.sendgrid.com/api-reference/single-sends/schedule-single-send) endpoint or SendGrid application UI. Additionally, the `now` keyword is a valid `send_at` value only when using the Schedule Single Send endpoint. Setting this property to `now` with this endpoint will cause an error."
        },
        {
          "name": "send_to",
          "type": "object",
          "location": "body",
          "description": "Send to"
        }
      ]
    },
    {
      "name": "messages_download-csv",
      "description": "**This endpoint will return a presigned URL that can be used to download the CSV that was requested from the 'Request a CSV' endpoint.**. Required: download_uuid. Returns the MessagesDownloadCsvResponse.",
      "method": "GET",
      "path": "/v3/messages/download/{download_uuid}",
      "params": [
        {
          "name": "download_uuid",
          "type": "string",
          "location": "path",
          "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 is ready to download",
          "required": true
        }
      ]
    },
    {
      "name": "messages_get",
      "description": "Get all of the details about the specified message. For Regional (EU) subusers, no data will be generated for this service. Required: msg_id. Returns the Message.",
      "method": "GET",
      "path": "/v3/messages/{msg_id}",
      "params": [
        {
          "name": "msg_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the message you are requesting details for.",
          "required": true
        }
      ]
    },
    {
      "name": "messages_list",
      "description": "Filter all messages to search your Email Activity. All queries must be [URL encoded](https://meyerweb.com/eric/tools/dencoder/), and use the following format: `query={query_type}='{query_content}'` Once URL encoded, the previous query will look like this: `query=type%3D%22query_content%22` For example, to filter by a specific email, use the following query: `query=to_email%3D%22example%40example.com%22` Visit our [Query Reference section](https://docs.sendgrid.com/for-developers/sending-email/getting-started-email-activity-api#query-reference) to see a full list of basic query types and examples. Required: query. Optional: limit (default: 10). Returns the MessagesListResponse.",
      "method": "GET",
      "path": "/v3/messages",
      "params": [
        {
          "name": "query",
          "type": "string",
          "location": "query",
          "description": "Use the query syntax to filter your email activity. Combine up to 160 filter conditions per request.",
          "required": true
        },
        {
          "name": "limit",
          "type": "float",
          "location": "query",
          "description": "The number of messages returned. This parameter must be greater than 0 and less than or equal to 1000"
        }
      ]
    },
    {
      "name": "messages_request-csv",
      "description": "This request will kick off a backend process to generate a CSV file. Once generated, the worker will then send an email for the user download the file. The link will expire in 3 days. The CSV will contain the events from the last 30 days, limited to the last 1 million events maximum. This endpoint will be rate limited to 1 request every 12 hours (rate limit may change). This endpoint is similar to the GET Single Message endpoint - the only difference is that /download is added to indicate that this is a CSV download requests but the same query is used to determine what the CSV should contain. Optional: query. Returns the new MessagesRequestCsvResponse.",
      "method": "POST",
      "path": "/v3/messages/download",
      "params": [
        {
          "name": "query",
          "type": "string",
          "location": "query",
          "description": "Uses a SQL like syntax to indicate which messages to include in the CSV"
        }
      ]
    },
    {
      "name": "partner-settings_list",
      "description": "**This endpoint allows you to retrieve a paginated list of all partner settings that you can enable.** You can use the `limit` query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the `offset` query parameter to control the position in the list from which to start retrieving additional items.'. Optional: limit, offset (default: 0). Returns the PartnerSettingsListResponse.",
      "method": "GET",
      "path": "/v3/partner_settings",
      "params": [
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "`limit` sets the page size, i."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The number of items in the list to skip over before starting to retrieve the items for the..."
        }
      ]
    },
    {
      "name": "partners_add-account-ips",
      "description": "Adds IP(s) to the specified account. Required: accountID, count, region. Returns the new AddAccountIpsResponse.",
      "method": "POST",
      "path": "/v3/partners/accounts/{accountID}/ips",
      "params": [
        {
          "name": "accountID",
          "type": "string",
          "location": "path",
          "description": "Twilio SendGrid account ID",
          "required": true
        },
        {
          "name": "count",
          "type": "int",
          "location": "body",
          "description": "Number of IPs to add (maximum 10 per request)",
          "required": true
        },
        {
          "name": "region",
          "type": "string",
          "location": "body",
          "description": "The region where the IPs should be provisioned (all IPs in a single request must be from the same region)",
          "required": true
        }
      ]
    },
    {
      "name": "partners_authenticate-account",
      "description": "Authenticates and logs in a user to Twilio Sendgrid as a specific admin identity configured for SSO by partner. Any additional teammates or subusers will need to log in directly via app.sendgrid.com. Required: accountID.",
      "method": "POST",
      "path": "/v3/partners/accounts/{accountID}/sso",
      "params": [
        {
          "name": "accountID",
          "type": "string",
          "location": "path",
          "description": "Twilio SendGrid account ID",
          "required": true
        }
      ]
    },
    {
      "name": "partners_create-account",
      "description": "Creates a new account, with specified offering, under the organization. Required: offerings. Optional: profile. Returns the new AccountProvisioningAccountId.",
      "method": "POST",
      "path": "/v3/partners/accounts",
      "params": [
        {
          "name": "offerings",
          "type": "array",
          "location": "body",
          "description": "List of offering names to assign to account.",
          "required": true
        },
        {
          "name": "profile",
          "type": "object",
          "location": "body",
          "description": "Profile"
        }
      ]
    },
    {
      "name": "partners_delete-account",
      "description": "Delete a specific account under your organization by account ID. Note that this is an **irreversible** action that does the following: - Revokes API Keys and SSO so that the account user cannot log in or access SendGrid data. - Removes all offerings and configured SendGrid resources such as dedicated IPs. - Cancels billing effective immediately. Required: accountID. Destructive.",
      "method": "DELETE",
      "path": "/v3/partners/accounts/{accountID}",
      "params": [
        {
          "name": "accountID",
          "type": "string",
          "location": "path",
          "description": "Twilio SendGrid account ID",
          "required": true
        }
      ]
    },
    {
      "name": "partners_get-account-state",
      "description": "Retrieve the state of the specified account. Required: accountID. Returns the AccountProvisioningStateRead.",
      "method": "GET",
      "path": "/v3/partners/accounts/{accountID}/state",
      "params": [
        {
          "name": "accountID",
          "type": "string",
          "location": "path",
          "description": "Twilio SendGrid account ID",
          "required": true
        }
      ]
    },
    {
      "name": "partners_list-account",
      "description": "Retrieves all accounts under the organization. Optional: offset, limit (default: 10). Returns the AccountList.",
      "method": "GET",
      "path": "/v3/partners/accounts",
      "params": [
        {
          "name": "offset",
          "type": "string",
          "location": "query",
          "description": "The last item successfully retrieved"
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "The number of items to return"
        }
      ]
    },
    {
      "name": "partners_list-account-ips",
      "description": "Retrieves a paginated list of IPs associated with the specified account, ordered by most recently added IP. Required: accountID. Optional: limit (default: 10), offset. Returns the AccountIpsResponse.",
      "method": "GET",
      "path": "/v3/partners/accounts/{accountID}/ips",
      "params": [
        {
          "name": "accountID",
          "type": "string",
          "location": "path",
          "description": "Twilio SendGrid account ID",
          "required": true
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "Number of items to return"
        },
        {
          "name": "offset",
          "type": "string",
          "location": "query",
          "description": "The last item successfully retrieved"
        }
      ]
    },
    {
      "name": "partners_list-account-offering",
      "description": "Retrieves offering information about the specified account. Required: accountID. Returns the AccountProvisioningAssignedOfferingList.",
      "method": "GET",
      "path": "/v3/partners/accounts/{accountID}/offerings",
      "params": [
        {
          "name": "accountID",
          "type": "string",
          "location": "path",
          "description": "Twilio SendGrid account ID",
          "required": true
        }
      ]
    },
    {
      "name": "partners_list-offering",
      "description": "Retrieves offerings available under the organization. Returns the AccountProvisioningCatalog.",
      "method": "GET",
      "path": "/v3/partners/offerings",
      "params": []
    },
    {
      "name": "partners_remove-account-ips",
      "description": "Removes IP(s) from the specified account. Required: accountID, ips. Destructive.",
      "method": "DELETE",
      "path": "/v3/partners/accounts/{accountID}/ips",
      "params": [
        {
          "name": "accountID",
          "type": "string",
          "location": "path",
          "description": "Twilio SendGrid account ID",
          "required": true
        },
        {
          "name": "ips",
          "type": "array",
          "location": "body",
          "description": "List of specific IP addresses to remove (maximum 10 per request)",
          "required": true
        }
      ]
    },
    {
      "name": "partners_update-account-offering",
      "description": "Changes a package offering for the specified account. Please note that an account can have only one package offering. Also associates one or more add-on offerings such as Marketing Campaigns, Dedicated IP Addresses, and Expert Services to the specified account. Required: accountID, offerings. Returns the updated AccountProvisioningOfferingList.",
      "method": "PUT",
      "path": "/v3/partners/accounts/{accountID}/offerings",
      "params": [
        {
          "name": "accountID",
          "type": "string",
          "location": "path",
          "description": "Twilio SendGrid account ID",
          "required": true
        },
        {
          "name": "offerings",
          "type": "array",
          "location": "body",
          "description": "List of offerings to assign to account.",
          "required": true
        }
      ]
    },
    {
      "name": "partners_update-account-state",
      "description": "Update the state of the specified account. Required: accountID, state.",
      "method": "PUT",
      "path": "/v3/partners/accounts/{accountID}/state",
      "params": [
        {
          "name": "accountID",
          "type": "string",
          "location": "path",
          "description": "Twilio SendGrid account ID",
          "required": true
        },
        {
          "name": "state",
          "type": "string",
          "location": "body",
          "description": "The state of the account (e.g., `activated`, `deactivated`)",
          "required": true
        }
      ]
    },
    {
      "name": "recipients_erase-email-data",
      "description": "**This operation allows you to delete your recipients' personal email data** The Delete Recipients' Email Data operation accepts a list of 5,000 `email_addresses` or a total payload size of 256Kb per request, whichever comes first. Upon a successful request with this operation, SendGrid will run a search on the email addresses provided against the SendGrid system to identify matches. SendGrid will then delete all personal data associated with the matched users such as the recipients' names, email addresses, subject lines, categories, and IP addresses. This endpoint is rate limited to 100 requests per minute. If more requests need to be made, consider using the batch option to include multiple email addresses in each request (up to 5,000 addresses per request). All email addresses are filtered for uniqueness and tested for structural validity—any invalid addresses will be returned in an error response. Please note that recipient data is deleted for the account making the request only—deletions do not cascade from a parent account to its Subusers' recipients. To delete a Subuser's recipients' data, you can use the `on-behalf-of` header. Required: email_addresses. Returns the new RecipientsDataErasureJobId.",
      "method": "POST",
      "path": "/v3/recipients/erasejob",
      "params": [
        {
          "name": "email_addresses",
          "type": "array",
          "location": "body",
          "description": "List of unique recipient email addresses whose PII will be erased. You may include a maximum of 5,000 addresses or a maximum payload size of 256Kb, whichever comes first.",
          "required": true
        }
      ]
    },
    {
      "name": "scopes_list",
      "description": "**This endpoint returns a list of all scopes that this user has access to.** API Keys are used to authenticate with [SendGrid's v3 API](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/authorization). API Keys may be assigned certain permissions, or scopes, that limit which API endpoints they are able to access. This endpoint returns all the scopes assigned to the key you use to authenticate with it. To retrieve the scopes assigned to another key, you can pass an API key ID to the 'Retrieve an existing API key' endpoint. For a more detailed explanation of how you can use API Key permissions, please visit our [API Keys documentation](https://sendgrid.com/docs/ui/account-and-settings/api-keys/).",
      "method": "GET",
      "path": "/v3/scopes",
      "params": []
    },
    {
      "name": "send-ips_add-ip",
      "description": "This operation adds a Twilio SendGrid IP address to your account. You can also assign up to 100 Subusers to the IP address at creation. Required: is_auto_warmup, is_parent_assigned. Optional: include_region (default: false), region (default: us), subusers. Returns the new SendIpsAddIpResponse.",
      "method": "POST",
      "path": "/v3/send_ips/ips",
      "params": [
        {
          "name": "include_region",
          "type": "bool",
          "location": "body",
          "description": "Boolean indicating whether or not to return the IP address's region information in the response."
        },
        {
          "name": "is_auto_warmup",
          "type": "bool",
          "location": "body",
          "description": "Indicates if the IP address is set to automatically [warmup](https://docs.sendgrid.com/ui/sending-email/warming-up-an-ip-address).",
          "required": true
        },
        {
          "name": "is_parent_assigned",
          "type": "bool",
          "location": "body",
          "description": "Indicates if a parent on the account is able to send email from the IP address.",
          "required": true
        },
        {
          "name": "region",
          "type": "string",
          "location": "body",
          "description": "The region to which the IP address is assigned. This property will only be returned if the `include_region` query parameter is included and set to `true` as part of the API request."
        },
        {
          "name": "subusers",
          "type": "array",
          "location": "body",
          "description": "An array of Subuser IDs the IP address will be assigned to."
        }
      ]
    },
    {
      "name": "send-ips_add-ips-to-ip-pool",
      "description": "This operation appends a batch of IPs to an IP Pool. This operation requires all IP assignments to succeed. If any IP assignments fail, this endpoint will return an error. Required: poolid, ips. Returns the new SendIpsAddIpsToIpPoolResponse.",
      "method": "POST",
      "path": "/v3/send_ips/pools/{poolid}/ips:batchAdd",
      "params": [
        {
          "name": "poolid",
          "type": "string",
          "location": "path",
          "description": "Specifies the unique ID for an IP Pool.",
          "required": true
        },
        {
          "name": "ips",
          "type": "array",
          "location": "body",
          "description": "An array of IP addresses to assign to the specified IP Pool. All assignments must succeed.",
          "required": true
        }
      ]
    },
    {
      "name": "send-ips_add-sub-users-to-ip",
      "description": "This operation appends a batch of Subusers to a specified IP address. This endpoint requires all Subuser assignments to succeed. If a Subuser assignment fails, this endpoint will return an error. Required: ip, subusers. Returns the new SendIpsAddSubUsersToIpResponse.",
      "method": "POST",
      "path": "/v3/send_ips/ips/{ip}/subusers:batchAdd",
      "params": [
        {
          "name": "ip",
          "type": "string",
          "location": "path",
          "description": "The `ip` path parameter specifies an IP address to make the request against.",
          "required": true
        },
        {
          "name": "subusers",
          "type": "array",
          "location": "body",
          "description": "An array of Subuser IDs to be assigned to the specified IP address. All Subuser assignments must succeed.",
          "required": true
        }
      ]
    },
    {
      "name": "send-ips_create-ip-pool",
      "description": "This operation will create a named IP Pool and associate specified IP addresses with the newly created Pool. This operation requires all IP assignments to succeed. If any IP assignments fail, this endpoint will return an error and the Pool will not be created. Each IP Pool may have a maximum of 100 assigned IP addresses. Required: name. Optional: ips. Returns the new SendIpsCreateIpPoolResponse.",
      "method": "POST",
      "path": "/v3/send_ips/pools",
      "params": [
        {
          "name": "ips",
          "type": "array",
          "location": "body",
          "description": "An array of IP addresses to assign to the IP Pool. All assignments must succeed."
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The name to assign to the IP Pool. An IP Pool name cannot begin with a space or period.",
          "required": true
        }
      ]
    },
    {
      "name": "send-ips_delete-ip-pool",
      "description": "This operation deletes an IP Pool and unassigns all IP addresses associated with the Pool. IP addresses associated with the deleted Pool will remain in your account. Required: poolid. Destructive.",
      "method": "DELETE",
      "path": "/v3/send_ips/pools/{poolid}",
      "params": [
        {
          "name": "poolid",
          "type": "string",
          "location": "path",
          "description": "Specifies the unique ID for an IP Pool.",
          "required": true
        }
      ]
    },
    {
      "name": "send-ips_delete-ips-from-ip-pool",
      "description": "This operation removes a batch of IPs from an IP Pool. All IPs associated with the Pool will be unassigned from the deleted Pool. However, this operation does not remove the IPs from your account. Required: poolid, ips.",
      "method": "POST",
      "path": "/v3/send_ips/pools/{poolid}/ips:batchDelete",
      "params": [
        {
          "name": "poolid",
          "type": "string",
          "location": "path",
          "description": "Specifies the unique ID for an IP Pool.",
          "required": true
        },
        {
          "name": "ips",
          "type": "array",
          "location": "body",
          "description": "An array of IP addresses to remove from the specified IP Pool.",
          "required": true
        }
      ]
    },
    {
      "name": "send-ips_delete-sub-users-from-ip",
      "description": "This operation removes a batch of Subusers from a specified IP address. Required: ip, subusers.",
      "method": "POST",
      "path": "/v3/send_ips/ips/{ip}/subusers:batchDelete",
      "params": [
        {
          "name": "ip",
          "type": "string",
          "location": "path",
          "description": "The `ip` path parameter specifies an IP address to make the request against.",
          "required": true
        },
        {
          "name": "subusers",
          "type": "array",
          "location": "body",
          "description": "An array of Subuser IDs to be removed from the specified IP address.",
          "required": true
        }
      ]
    },
    {
      "name": "send-ips_get-ip",
      "description": "This operation returns details for a specified IP address. Details include whether the IP is assigned to a parent account, set to warm up automatically, which Pools the IP is associated with, when the IP was added and modified, whether the IP is leased, and whether the IP is enabled. Note that this operation will not return Subuser information associated with the IP. To retrieve Subuser information, use the 'Get a List of Subusers Assigned to an IP' endpoint. Required: ip. Optional: include_region (default: false).",
      "method": "GET",
      "path": "/v3/send_ips/ips/{ip}",
      "params": [
        {
          "name": "ip",
          "type": "string",
          "location": "path",
          "description": "The `ip` path parameter specifies an IP address to make the request against.",
          "required": true
        },
        {
          "name": "include_region",
          "type": "bool",
          "location": "query",
          "description": "Boolean indicating whether or not to return the IP Pool's region information in the response."
        }
      ]
    },
    {
      "name": "send-ips_get-ip-pool",
      "description": "This operation will return the details for a specified IP Pool, including the Pool's name, ID, a sample list of the IPs associated with the Pool, and the total number of IPs belonging to the Pool. A maximum of 10 IPs will be returned per IP Pool by default. To retrieve additional IP addresses associated with a Pool, use the 'Get IPs Assigned to an IP Pool' operation. Required: poolid. Optional: include_region (default: false). Returns the SendIpsGetIpPoolResponse.",
      "method": "GET",
      "path": "/v3/send_ips/pools/{poolid}",
      "params": [
        {
          "name": "poolid",
          "type": "string",
          "location": "path",
          "description": "Specifies the unique ID for an IP Pool.",
          "required": true
        },
        {
          "name": "include_region",
          "type": "bool",
          "location": "query",
          "description": "Boolean indicating whether or not to return the IP Pool's region information in the response."
        }
      ]
    },
    {
      "name": "send-ips_list-ip",
      "description": "This operation returns a list of all IP addresses associated with your account. A sample of IP details is returned with each IP, including which Pools the IP is associated with, whether the IP is set to warm up automatically, and when the IP was last updated. ### Limitations The `is_parent_assigned` parameter and `pool` parameter cannot be used at the same time. By definition, an IP cannot be assigned to a Pool if it is not first enabled. You can use either the `before_key` or `after_key` in combination with the `limit` parameter to iterate through paginated results but not both. Optional: ip, limit, after_key (plus 9 more).",
      "method": "GET",
      "path": "/v3/send_ips/ips",
      "params": [
        {
          "name": "ip",
          "type": "string",
          "location": "query",
          "description": "Specifies an IP address. The `ip` query parameter can be used to filter results by IP address."
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "Specifies the number of results to be returned by the API."
        },
        {
          "name": "after_key",
          "type": "int",
          "location": "query",
          "description": "Specifies which items to be returned by the API."
        },
        {
          "name": "before_key",
          "type": "string",
          "location": "query",
          "description": "Specifies which items to be returned by the API. When the `before_key` is specified, the API will return items beginning from the first item before the item specified. This parameter can be used in combination with `limit` to iterate through paginated results."
        },
        {
          "name": "is_leased",
          "type": "bool",
          "location": "query",
          "description": "Indicates whether an IP address is leased from Twilio SendGrid. If `false`, the IP address is not a Twilio SendGrid IP; it is a customer's own IP that has been added to their Twilio SendGrid account."
        },
        {
          "name": "is_enabled",
          "type": "bool",
          "location": "query",
          "description": "Indicates if the IP address is billed and able to send email. This parameter applies to non-Twilio SendGrid APIs that been added to your Twilio SendGrid account. This parameter's value is `null` for Twilio SendGrid IP addresses."
        },
        {
          "name": "is_parent_assigned",
          "type": "bool",
          "location": "query",
          "description": "A parent must be assigned to an IP address before the parent can send mail from the IP and before the address can be assigned to an IP pool. Set this parameter value to true to allow the parent to send mail from the IP and make the IP eligible for IP pool assignment using the IP pool endpoints."
        },
        {
          "name": "pool",
          "type": "string",
          "location": "query",
          "description": "Specifies the unique ID for an IP Pool. When included, only IP addresses belonging to the specified Pool will be returned."
        },
        {
          "name": "start_added_at",
          "type": "int",
          "location": "query",
          "description": "The `start_added_at` and `end_added_at` parameters are used to set a time window. IP addresses that were added to your account in the specified time window will be returned. The `start_added_at` parameter sets the beginning of the time window."
        },
        {
          "name": "end_added_at",
          "type": "int",
          "location": "query",
          "description": "The `start_added_at` and `end_added_at` parameters are used to set a time window. IP addresses that were added to your account in the specified time window will be returned. The `end_added_at` parameter sets the end of the time window."
        },
        {
          "name": "region",
          "type": "string",
          "location": "query",
          "description": "Allowed values are `all`, `eu`, and `us`. If you provide a specific region, results will include all pools that have at least one IP in the filtered region. If `all`, pools with at least one IP (regardless of region) will be returned. If the `region` filter is not provided, the query returns all pools, including empty ones."
        },
        {
          "name": "include_region",
          "type": "bool",
          "location": "query",
          "description": "Boolean indicating whether or not to return the IP Pool's region information in the response."
        }
      ]
    },
    {
      "name": "send-ips_list-ip-assigned-to-ip-pool",
      "description": "This operation returns the IP addresses that are assigned to the specified IP pool. Required: poolid. Optional: limit, after_key, include_region (default: false).",
      "method": "GET",
      "path": "/v3/send_ips/pools/{poolid}/ips",
      "params": [
        {
          "name": "poolid",
          "type": "string",
          "location": "path",
          "description": "Specifies the unique ID for an IP Pool.",
          "required": true
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "Specifies the number of results to be returned by the API."
        },
        {
          "name": "after_key",
          "type": "int",
          "location": "query",
          "description": "Specifies which items to be returned by the API."
        },
        {
          "name": "include_region",
          "type": "bool",
          "location": "query",
          "description": "Boolean indicating whether or not to return the IP Pool's region information in the response."
        }
      ]
    },
    {
      "name": "send-ips_list-ip-pool",
      "description": "This operation returns a list of your IP Pools and a sample of each Pools' associated IP addresses. A maximum of 10 IPs will be returned per IP Pool by default. To retrieve additional IP addresses associated with a Pool, use the 'Get IPs Assigned to an IP Pool' operation. Each user may have a maximum of 100 IP Pools. Optional: limit, after_key, ip (plus 2 more).",
      "method": "GET",
      "path": "/v3/send_ips/pools",
      "params": [
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "Specifies the number of results to be returned by the API."
        },
        {
          "name": "after_key",
          "type": "int",
          "location": "query",
          "description": "Specifies which items to be returned by the API."
        },
        {
          "name": "ip",
          "type": "string",
          "location": "query",
          "description": "Specifies an IP address. The `ip` query parameter can be used to filter results by IP address."
        },
        {
          "name": "region",
          "type": "string",
          "location": "query",
          "description": "Allowed values are `all`, `eu`, and `us`. If you provide a specific region, results will include all pools that have at least one IP in the filtered region. If `all`, pools with at least one IP (regardless of region) will be returned. If the `region` filter is not provided, the query returns all pools, including empty ones."
        },
        {
          "name": "include_region",
          "type": "bool",
          "location": "query",
          "description": "Boolean indicating whether or not to return the IP Pool's region information in the response."
        }
      ]
    },
    {
      "name": "send-ips_list-sub-user-assigned-to-ip",
      "description": "This operation returns a list of Subuser IDs that have been assigned the specified IP address. To retrieve more information about the returned Subusers, use the [Subusers API](https://docs.sendgrid.com/api-reference/subusers-api/list-all-subusers). You can use the `after_key` and `limit` query parameters to iterate through paginated results. The maximum limit is 100, meaning you may retrieve up to 100 Subusers per request. If the `after_key` in the API response is not null, there are more Subusers assigned to the IP address than those returned in the request. You can repeat the request with the non-null `after_key` value and the same limit to retrieve the next group of Subusers. Required: ip. Optional: after_key, limit.",
      "method": "GET",
      "path": "/v3/send_ips/ips/{ip}/subusers",
      "params": [
        {
          "name": "ip",
          "type": "string",
          "location": "path",
          "description": "The `ip` path parameter specifies an IP address to make the request against.",
          "required": true
        },
        {
          "name": "after_key",
          "type": "int",
          "location": "query",
          "description": "Specifies which items to be returned by the API."
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "Specifies the number of results to be returned by the API. This parameter can be used in combination with the `after_key` parameters to iterate through paginated results. The maximum limit is 100."
        }
      ]
    },
    {
      "name": "send-ips_update-ip",
      "description": "This operation updates an IP address's settings, including whether the IP is set to warm up automatically, if the IP is assigned by a parent account, and whether the IP is enabled or disabled. The request body must include at least one of the `is_auto_warmup`, `is_parent_assigned`, or `is_enabled` fields. Required: ip. Optional: is_auto_warmup, is_enabled, is_parent_assigned. Returns the updated SendIpsUpdateIpResponse.",
      "method": "PATCH",
      "path": "/v3/send_ips/ips/{ip}",
      "params": [
        {
          "name": "ip",
          "type": "string",
          "location": "path",
          "description": "The `ip` path parameter specifies an IP address to make the request against.",
          "required": true
        },
        {
          "name": "is_auto_warmup",
          "type": "bool",
          "location": "body",
          "description": "Indicates if the IP address is set to automatically [warmup](https://docs.sendgrid.com/ui/sending-email/warming-up-an-ip-address)."
        },
        {
          "name": "is_enabled",
          "type": "bool",
          "location": "body",
          "description": "Indicates if the IP address is billed and able to send email. This parameter applies to non-Twilio SendGrid APIs that been added to your Twilio SendGrid account. This parameter's value is `null` for Twilio SendGrid IP addresses."
        },
        {
          "name": "is_parent_assigned",
          "type": "bool",
          "location": "body",
          "description": "Indicates if a parent on the account is able to send email from the IP address."
        }
      ]
    },
    {
      "name": "send-ips_update-ip-pool",
      "description": "This operation will rename an IP Pool. An IP Pool name cannot start with a dot/period (.) or space. Required: poolid, name. Returns the updated SendIpsUpdateIpPoolResponse.",
      "method": "PUT",
      "path": "/v3/send_ips/pools/{poolid}",
      "params": [
        {
          "name": "poolid",
          "type": "string",
          "location": "path",
          "description": "Specifies the unique ID for an IP Pool.",
          "required": true
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The name to assign to the IP Pool. An IP Pool name cannot begin with a space or period.",
          "required": true
        }
      ]
    },
    {
      "name": "senders_create",
      "description": "**This endpoint allows you to create a new sender identity.** You may create up to 100 unique sender identities. Required: address, city, country, nickname. Optional: address_2, from, reply_to (plus 2 more). Returns the new SenderId.",
      "method": "POST",
      "path": "/v3/senders",
      "params": [
        {
          "name": "address",
          "type": "string",
          "location": "body",
          "description": "The physical address of the sender identity.",
          "required": true
        },
        {
          "name": "address_2",
          "type": "string",
          "location": "body",
          "description": "Additional sender identity address information."
        },
        {
          "name": "city",
          "type": "string",
          "location": "body",
          "description": "The city of the sender identity.",
          "required": true
        },
        {
          "name": "country",
          "type": "string",
          "location": "body",
          "description": "The country of the sender identity.",
          "required": true
        },
        {
          "name": "from",
          "type": "object",
          "location": "body",
          "description": "From"
        },
        {
          "name": "nickname",
          "type": "string",
          "location": "body",
          "description": "A nickname for the sender identity. Not used for sending.",
          "required": true
        },
        {
          "name": "reply_to",
          "type": "object",
          "location": "body",
          "description": "Reply to"
        },
        {
          "name": "state",
          "type": "string",
          "location": "body",
          "description": "The state of the sender identity."
        },
        {
          "name": "zip",
          "type": "string",
          "location": "body",
          "description": "The zipcode of the sender identity."
        }
      ]
    },
    {
      "name": "senders_delete",
      "description": "**This endpoint allows you to delete one of your sender identities.**. Required: sender_id. Destructive.",
      "method": "DELETE",
      "path": "/v3/senders/{sender_id}",
      "params": [
        {
          "name": "sender_id",
          "type": "int",
          "location": "path",
          "description": "The ID of the sender identity that you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "senders_get",
      "description": "**This endpoint allows you to retrieve a specific sender identity.**. Required: sender_id. Returns the SenderId.",
      "method": "GET",
      "path": "/v3/senders/{sender_id}",
      "params": [
        {
          "name": "sender_id",
          "type": "int",
          "location": "path",
          "description": "The ID of the sender identity that you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "senders_list",
      "description": "**This endpoint allows you to retrieve a list of all sender identities that have been created for your account.**. Returns the SendersListResponse.",
      "method": "GET",
      "path": "/v3/senders",
      "params": []
    },
    {
      "name": "senders_update",
      "description": "**This endpoint allows you to update a sender identity.** Updates to `from.email` require re-verification. Partial updates are allowed, but fields that are marked as 'required' in the POST (create) endpoint must not be nil if that field is included in the PATCH request. Required: sender_id. Optional: address, address_2, city (plus 6 more). Returns the updated SenderId.",
      "method": "PATCH",
      "path": "/v3/senders/{sender_id}",
      "params": [
        {
          "name": "sender_id",
          "type": "int",
          "location": "path",
          "description": "The ID of the sender identity that you want to retrieve.",
          "required": true
        },
        {
          "name": "address",
          "type": "string",
          "location": "body",
          "description": "The physical address of the sender identity."
        },
        {
          "name": "address_2",
          "type": "string",
          "location": "body",
          "description": "Additional sender identity address information."
        },
        {
          "name": "city",
          "type": "string",
          "location": "body",
          "description": "The city of the sender identity."
        },
        {
          "name": "country",
          "type": "string",
          "location": "body",
          "description": "The country of the sender identity."
        },
        {
          "name": "from",
          "type": "object",
          "location": "body",
          "description": "From"
        },
        {
          "name": "nickname",
          "type": "string",
          "location": "body",
          "description": "A nickname for the sender identity. Not used for sending."
        },
        {
          "name": "reply_to",
          "type": "object",
          "location": "body",
          "description": "Reply to"
        },
        {
          "name": "state",
          "type": "string",
          "location": "body",
          "description": "The state of the sender identity."
        },
        {
          "name": "zip",
          "type": "string",
          "location": "body",
          "description": "The zipcode of the sender identity."
        }
      ]
    },
    {
      "name": "senders_resend-verification_reset-sender-verification",
      "description": "**This endpoint allows you to resend a sender identity verification email.**. Required: sender_id.",
      "method": "POST",
      "path": "/v3/senders/{sender_id}/resend_verification",
      "params": [
        {
          "name": "sender_id",
          "type": "int",
          "location": "path",
          "description": "The ID of the sender identity for which you would like to resend a verification email.",
          "required": true
        }
      ]
    },
    {
      "name": "sso_create-certificate",
      "description": "**This endpoint allows you to create an SSO certificate.**. Required: integration_id, public_certificate. Optional: enabled. Returns the new SsoCertificateBody.",
      "method": "POST",
      "path": "/v3/sso/certificates",
      "params": [
        {
          "name": "enabled",
          "type": "bool",
          "location": "body",
          "description": "Indicates if the certificate is enabled."
        },
        {
          "name": "integration_id",
          "type": "string",
          "location": "body",
          "description": "An ID that matches a certificate to a specific IdP integration. This is the `id` returned by the 'Get All SSO Integrations' endpoint.",
          "required": true
        },
        {
          "name": "public_certificate",
          "type": "string",
          "location": "body",
          "description": "This public certificate allows SendGrid to verify that SAML requests it receives are signed by an IdP that it recognizes.",
          "required": true
        }
      ]
    },
    {
      "name": "sso_create-integration",
      "description": "**This endpoint allows you to create an SSO integration.**. Required: enabled, entity_id, name, signin_url, signout_url. Optional: completed_integration. Returns the new SsoIntegration.",
      "method": "POST",
      "path": "/v3/sso/integrations",
      "params": [
        {
          "name": "completed_integration",
          "type": "bool",
          "location": "body",
          "description": "Indicates if the integration is complete."
        },
        {
          "name": "enabled",
          "type": "bool",
          "location": "body",
          "description": "Indicates if the integration is enabled.",
          "required": true
        },
        {
          "name": "entity_id",
          "type": "string",
          "location": "body",
          "description": "An identifier provided by your IdP to identify Twilio SendGrid in the SAML interaction. This is called the 'SAML Issuer ID' in the Twilio SendGrid UI.",
          "required": true
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The name of your integration. This name can be anything that makes sense for your organization (eg. Twilio SendGrid)",
          "required": true
        },
        {
          "name": "signin_url",
          "type": "string",
          "location": "body",
          "description": "The IdP's SAML POST endpoint. This endpoint should receive requests and initiate an SSO login flow. This is called the 'Embed Link' in the Twilio SendGrid UI.",
          "required": true
        },
        {
          "name": "signout_url",
          "type": "string",
          "location": "body",
          "description": "This URL is relevant only for an IdP-initiated authentication flow. If a user authenticates from their IdP, this URL will return them to their IdP when logging out.",
          "required": true
        }
      ]
    },
    {
      "name": "sso_create-teammate",
      "description": "**This endpoint allows you to create an SSO Teammate.** The email address provided for the Teammate will also function as the Teammate's username. Once created, the Teammate's email address cannot be changed. ### Scopes When creating a Teammate, you will assign it permissions or scopes. These scopes determine which actions the Teammate can perform and which features they can access. Scopes are provided with one of three properties passed to this endpoint: `is_admin`, `scopes`, and `persona`. You can make a Teammate an administrator by setting `is_admin` to `true`. Administrators will have all scopes assigned to them. Alternatively, you can assign a `persona` to the teammate, which will assign them a block of permissions commonly required for that type of user. See the 'Persona scopes' section of [**Teammate Permissions**](https://docs.sendgrid.com/ui/account-and-settings/teammate-permissions#persona-scopes) for a list of permsissions granted by persona. Lastly, you can assign individual permissions with the `scopes` property. See [**Teammate Permissions**](https://docs.sendgrid.com/ui/account-and-settings/teammate-permissions) for a full list of scopes that can be assigned to a Teammate. ### Subuser access SendGrid Teammates may be assigned access to one or more Subusers. Subusers function like SendGrid sub-accounts with their own resources. See [**Subusers**](https://docs.sendgrid.com/ui/account-and-settings/subusers) for more information. When assigning Subuser access to a Teammate, you may set the `has_restricted_subuser_access` property to `true` to constrain the Teammate so that they can operate only on behalf of the Subusers to which they are assigned. You may further set the level of access the Teammate has to each Subuser with the `subuser_access` property. Required: email, first_name, last_name. Optional: has_restricted_subuser_access, is_admin, persona (plus 2 more). Returns the new PostSsoTeammates201.",
      "method": "POST",
      "path": "/v3/sso/teammates",
      "params": [
        {
          "name": "email",
          "type": "string",
          "location": "body",
          "description": "Set this property to the Teammate's email address. This email address will also function as the Teammate's username and must match the address assigned to the user in your IdP. This address cannot be changed after the Teammate is created.",
          "required": true
        },
        {
          "name": "first_name",
          "type": "string",
          "location": "body",
          "description": "Set this property to the Teammate's first name.",
          "required": true
        },
        {
          "name": "has_restricted_subuser_access",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to give the Teammate permissions to operate only on behalf of a Subuser. This property value must be `true` if the `subuser_access` property is not empty. The `subuser_access` property determines which Subusers the Teammate may act on behalf of. If this property is set to `true`, you cannot specify individual `scopes`, assign a `persona`, or set `is_admin` to `true`—a Teammate cannot specify scopes for the parent account and have restricted Subuser access."
        },
        {
          "name": "is_admin",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` if the Teammate has admin permissions. You should not include the `scopes` or `persona` properties when setting the `is_admin` property to `true`—an admin will be allocated all scopes. See [**Teammate Permissions**](https://docs.sendgrid.com/ui/account-and-settings/teammate-permissions) for a complete list of scopes."
        },
        {
          "name": "last_name",
          "type": "string",
          "location": "body",
          "description": "Set this property to the Teammate's last name.",
          "required": true
        },
        {
          "name": "persona",
          "type": "string",
          "location": "body",
          "description": "A persona represents a group of permissions often required by a type of Teammate such as a developer or marketer. Assigning a persona allows you to allocate a group of pre-defined permissions rather than assigning each scope individually. See [**Teammate Permissions**](https://docs.sendgrid.com/ui/account-and-settings/teammate-permissions) for a full list of the scopes assigned to each persona."
        },
        {
          "name": "scopes",
          "type": "array",
          "location": "body",
          "description": "Add or remove permissions from a Teammate using this `scopes` property. See [**Teammate Permissions**](https://docs.sendgrid.com/ui/account-and-settings/teammate-permissions) for a complete list of available scopes. You should not include this propety in the request when using the `persona` property or when setting the `is_admin` property to `true`—assigning a `persona` or setting `is_admin` to `true` will allocate a group of permissions to the Teammate."
        },
        {
          "name": "subuser_access",
          "type": "array",
          "location": "body",
          "description": "Specify which Subusers the Teammate may access and act on behalf of with this property. If this property is populated, you must set the `has_restricted_subuser_access` property to `true`."
        }
      ]
    },
    {
      "name": "sso_delete-certificate",
      "description": "**This endpoint allows you to delete an SSO certificate.** You can retrieve a certificate's ID from the response provided by the 'Get All SSO Integrations' endpoint. Required: cert_id. Returns the SsoCertificateBody. Destructive.",
      "method": "DELETE",
      "path": "/v3/sso/certificates/{cert_id}",
      "params": [
        {
          "name": "cert_id",
          "type": "string",
          "location": "path",
          "description": "Cert id",
          "required": true
        }
      ]
    },
    {
      "name": "sso_delete-integration",
      "description": "**This endpoint allows you to delete an IdP configuration by ID.** You can retrieve the IDs for your configurations from the response provided by the 'Get All SSO Integrations' endpoint. Required: id. Destructive.",
      "method": "DELETE",
      "path": "/v3/sso/integrations/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        }
      ]
    },
    {
      "name": "sso_get-certificate",
      "description": "**This endpoint allows you to retrieve an individual SSO certificate.**. Required: cert_id. Returns the SsoCertificateBody.",
      "method": "GET",
      "path": "/v3/sso/certificates/{cert_id}",
      "params": [
        {
          "name": "cert_id",
          "type": "string",
          "location": "path",
          "description": "Cert id",
          "required": true
        }
      ]
    },
    {
      "name": "sso_get-integration",
      "description": "**This endpoint allows you to retrieve an SSO integration by ID.** You can retrieve the IDs for your configurations from the response provided by the 'Get All SSO Integrations' endpoint. Required: id. Optional: si. Returns the SsoIntegration.",
      "method": "GET",
      "path": "/v3/sso/integrations/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        },
        {
          "name": "si",
          "type": "bool",
          "location": "query",
          "description": "If this parameter is set to `true`, the response will include the `completed_integration` field."
        }
      ]
    },
    {
      "name": "sso_list-integration",
      "description": "**This endpoint allows you to retrieve all SSO integrations tied to your Twilio SendGrid account.** The IDs returned by this endpoint can be used by the APIs additional endpoints to modify your SSO integrations. Optional: si. Returns array of SsoIntegration.",
      "method": "GET",
      "path": "/v3/sso/integrations",
      "params": [
        {
          "name": "si",
          "type": "bool",
          "location": "query",
          "description": "If this parameter is set to `true`, the response will include the `completed_integration` field."
        }
      ]
    },
    {
      "name": "sso_list-integration-certificate",
      "description": "**This endpoint allows you to retrieve all your IdP configurations by configuration ID.** The `integration_id` expected by this endpoint is the `id` returned in the response by the 'Get All SSO Integrations' endpoint. Required: integration_id. Returns array of SsoCertificateBody.",
      "method": "GET",
      "path": "/v3/sso/integrations/{integration_id}/certificates",
      "params": [
        {
          "name": "integration_id",
          "type": "string",
          "location": "path",
          "description": "An ID that matches a certificate to a specific IdP integration.",
          "required": true
        }
      ]
    },
    {
      "name": "sso_update-certificate",
      "description": "**This endpoint allows you to update an existing certificate by ID.** You can retrieve a certificate's ID from the response provided by the 'Get All SSO Integrations' endpoint. Required: cert_id. Optional: enabled, integration_id, public_certificate. Returns the updated SsoCertificateBody.",
      "method": "PATCH",
      "path": "/v3/sso/certificates/{cert_id}",
      "params": [
        {
          "name": "cert_id",
          "type": "string",
          "location": "path",
          "description": "Cert id",
          "required": true
        },
        {
          "name": "enabled",
          "type": "bool",
          "location": "body",
          "description": "Indicates whether or not the certificate is enabled."
        },
        {
          "name": "integration_id",
          "type": "string",
          "location": "body",
          "description": "An ID that matches a certificate to a specific IdP integration."
        },
        {
          "name": "public_certificate",
          "type": "string",
          "location": "body",
          "description": "This public certificate allows SendGrid to verify that SAML requests it receives are signed by an IdP that it recognizes."
        }
      ]
    },
    {
      "name": "sso_update-integration",
      "description": "**This endpoint allows you to modify an exisiting SSO integration.** You can retrieve the IDs for your configurations from the response provided by the 'Get All SSO Integrations' endpoint. Required: id, enabled, entity_id, name, signin_url, signout_url. Optional: si, completed_integration. Returns the updated SsoIntegration.",
      "method": "PATCH",
      "path": "/v3/sso/integrations/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        },
        {
          "name": "si",
          "type": "bool",
          "location": "query",
          "description": "If this parameter is set to `true`, the response will include the `completed_integration` field."
        },
        {
          "name": "completed_integration",
          "type": "bool",
          "location": "body",
          "description": "Indicates if the integration is complete."
        },
        {
          "name": "enabled",
          "type": "bool",
          "location": "body",
          "description": "Indicates if the integration is enabled.",
          "required": true
        },
        {
          "name": "entity_id",
          "type": "string",
          "location": "body",
          "description": "An identifier provided by your IdP to identify Twilio SendGrid in the SAML interaction. This is called the 'SAML Issuer ID' in the Twilio SendGrid UI.",
          "required": true
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The name of your integration. This name can be anything that makes sense for your organization (eg. Twilio SendGrid)",
          "required": true
        },
        {
          "name": "signin_url",
          "type": "string",
          "location": "body",
          "description": "The IdP's SAML POST endpoint. This endpoint should receive requests and initiate an SSO login flow. This is called the 'Embed Link' in the Twilio SendGrid UI.",
          "required": true
        },
        {
          "name": "signout_url",
          "type": "string",
          "location": "body",
          "description": "This URL is relevant only for an IdP-initiated authentication flow. If a user authenticates from their IdP, this URL will return them to their IdP when logging out.",
          "required": true
        }
      ]
    },
    {
      "name": "sso_update-teammate",
      "description": "**This endpoint allows you to modify an existing SSO Teammate.** Only the parent user and Teammates with admin permissions can update another Teammate's permissions. ### Scopes When updating a Teammate, you will assign it permissions or scopes. These scopes determine which actions the Teammate can perform and which features they can access. Scopes are provided with one of three properties passed to this endpoint: `is_admin`, `scopes`, and `persona`. You can make a Teammate an administrator by setting `is_admin` to `true`. Administrators will have all scopes assigned to them. Alternatively, you can assign a `persona` to the teammate, which will assign them a block of permissions commonly required for that type of user. See the 'Persona scopes' section of [**Teammate Permissions**](https://docs.sendgrid.com/ui/account-and-settings/teammate-permissions#persona-scopes) for a list of permsissions granted by persona. Lastly, you can assign individual permissions with the `scopes` property. See [**Teammate Permissions**](https://docs.sendgrid.com/ui/account-and-settings/teammate-permissions) for a full list of scopes that can be assigned to a Teammate. ### Subuser access SendGrid Teammates may be assigned access to one or more Subusers. Subusers function like SendGrid sub-accounts with their own resources. See [**Subusers**](https://docs.sendgrid.com/ui/account-and-settings/subusers) for more information. When assigning Subuser access to a Teammate, you may set the `has_restricted_subuser_access` property to `true` to constrain the Teammate so that they can operate only on behalf of the Subusers to which they are assigned. You may further set the level of access the Teammate has to each Subuser with the `subuser_access` property. Required: username, first_name, last_name. Optional: has_restricted_subuser_access, is_admin, persona (plus 2 more). Returns the updated PatchSsoTeammates200.",
      "method": "PATCH",
      "path": "/v3/sso/teammates/{username}",
      "params": [
        {
          "name": "username",
          "type": "string",
          "location": "path",
          "description": "Set this parameter to the Teammate's email address. This address must be the same address assigned to the Teammate in your IdP.",
          "required": true
        },
        {
          "name": "first_name",
          "type": "string",
          "location": "body",
          "description": "Set this property to the Teammate's first name.",
          "required": true
        },
        {
          "name": "has_restricted_subuser_access",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to give the Teammate permissions to operate only on behalf of a Subuser. This property value must be `true` if the `subuser_access` property is not empty. The `subuser_access` property determines which Subusers the Teammate may act on behalf of. If this property is set to `true`, you cannot specify individual `scopes`, assign a `persona`, or set `is_admin` to `true`—a Teammate cannot specify scopes for the parent account and have restricted Subuser access."
        },
        {
          "name": "is_admin",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` if the Teammate has admin permissions. You should not include the `scopes` or `persona` properties when setting the `is_admin` property to `true`—an admin will be allocated all scopes. See [**Teammate Permissions**](https://docs.sendgrid.com/ui/account-and-settings/teammate-permissions) for a complete list of scopes."
        },
        {
          "name": "last_name",
          "type": "string",
          "location": "body",
          "description": "Set this property to the Teammate's last name.",
          "required": true
        },
        {
          "name": "persona",
          "type": "string",
          "location": "body",
          "description": "A persona represents a group of permissions often required by a type of Teammate such as a developer or marketer. Assigning a persona allows you to allocate a group of pre-defined permissions rather than assigning each scope individually. See [**Teammate Permissions**](https://docs.sendgrid.com/ui/account-and-settings/teammate-permissions) for a full list of the scopes assigned to each persona."
        },
        {
          "name": "scopes",
          "type": "array",
          "location": "body",
          "description": "Add or remove permissions from a Teammate using this `scopes` property. See [**Teammate Permissions**](https://docs.sendgrid.com/ui/account-and-settings/teammate-permissions) for a complete list of available scopes. You should not include this propety in the request when using the `persona` property or when setting the `is_admin` property to `true`—assigning a `persona` or setting `is_admin` to `true` will allocate a group of permissions to the Teammate."
        },
        {
          "name": "subuser_access",
          "type": "array",
          "location": "body",
          "description": "Specify which Subusers the Teammate may access and act on behalf of with this property. If this property is populated, you must set the `has_restricted_subuser_access` property to `true`."
        }
      ]
    },
    {
      "name": "stats_list",
      "description": "**This endpoint allows you to retrieve all of your global email statistics between a given date range.** Parent accounts can see either aggregated stats for the parent account or aggregated stats for a subuser specified in the `on-behalf-of` header. Subuser accounts will see only their own stats. Required: start_date. Optional: limit, offset, aggregated_by (plus 1 more). Returns array of StatsListItem.",
      "method": "GET",
      "path": "/v3/stats",
      "params": [
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "The number of results to return."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The point in the list to begin retrieving results."
        },
        {
          "name": "aggregated_by",
          "type": "string",
          "location": "query",
          "description": "How to group the statistics. Must be either 'day', 'week', or 'month'."
        },
        {
          "name": "start_date",
          "type": "string",
          "location": "query",
          "description": "The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.",
          "required": true
        },
        {
          "name": "end_date",
          "type": "string",
          "location": "query",
          "description": "The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."
        }
      ]
    },
    {
      "name": "subusers_create",
      "description": "**This endpoint allows you to create a new subuser.**. Required: email, ips, password, username. Optional: include_region (default: false), region (default: global). Returns the new SubuserPost.",
      "method": "POST",
      "path": "/v3/subusers",
      "params": [
        {
          "name": "email",
          "type": "string",
          "location": "body",
          "description": "The email address of the subuser.",
          "required": true
        },
        {
          "name": "include_region",
          "type": "bool",
          "location": "body",
          "description": "A flag that determines if the Subuser's region should be returned in the response. (Regional email is in Public Beta and requires SendGrid Pro plan or above.)"
        },
        {
          "name": "ips",
          "type": "array",
          "location": "body",
          "description": "The IP addresses that should be assigned to this subuser.",
          "required": true
        },
        {
          "name": "password",
          "type": "string",
          "location": "body",
          "description": "The password this subuser will use when logging into SendGrid.",
          "required": true
        },
        {
          "name": "region",
          "type": "string",
          "location": "body",
          "description": "The region this Subuser should be assigned to. Can be `global` or `eu`. (Regional email is in Public Beta and requires SendGrid Pro plan or above.)."
        },
        {
          "name": "username",
          "type": "string",
          "location": "body",
          "description": "The username for this subuser.",
          "required": true
        }
      ]
    },
    {
      "name": "subusers_delete",
      "description": "**This endpoint allows you to delete a subuser.** This is a permanent action. Once deleted, a subuser cannot be retrieved. Required: subuser_name. Destructive.",
      "method": "DELETE",
      "path": "/v3/subusers/{subuser_name}",
      "params": [
        {
          "name": "subuser_name",
          "type": "string",
          "location": "path",
          "description": "The username of the Subuser.",
          "required": true
        }
      ]
    },
    {
      "name": "subusers_list",
      "description": "**This endpoint allows you to retrieve a paginated list of all your subusers.** You can use the `username` query parameter to filter the list for specific subusers. You can use the `limit` query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the `offset` query parameter to control the position in the list from which to start retrieving additional items. Optional: username, limit, region (default: all) (plus 2 more). Returns array of Subuser.",
      "method": "GET",
      "path": "/v3/subusers",
      "params": [
        {
          "name": "username",
          "type": "string",
          "location": "query",
          "description": "The username of this subuser."
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "`limit` sets the page size, i."
        },
        {
          "name": "region",
          "type": "string",
          "location": "query",
          "description": "Filter for Subusers in this region. If not provided, all Subusers will be returned. All users can also be explicitly requested by using the filter `all`. Users who are not pinned to a region will be displayed as `global`."
        },
        {
          "name": "include_region",
          "type": "bool",
          "location": "query",
          "description": "Optional flag to include the regions of the Subusers in the response. If not provided, the region will be omitted from the response."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The number of items in the list to skip over before starting to retrieve the items for the..."
        }
      ]
    },
    {
      "name": "subusers_list-monthly-stat",
      "description": "**This endpoint allows you to retrieve the monthly email statistics for all subusers over the given date range.** When using the `sort_by_metric` to sort your stats by a specific metric, you can not sort by the following metrics: `bounce_drops`, `deferred`, `invalid_emails`, `processed`, `spam_report_drops`, `spam_reports`, or `unsubscribe_drops`. Required: date. Optional: subuser, sort_by_metric (default: delivered), sort_by_direction (default: desc) (plus 2 more). Returns the SubuserStats.",
      "method": "GET",
      "path": "/v3/subusers/stats/monthly",
      "params": [
        {
          "name": "date",
          "type": "string",
          "location": "query",
          "description": "The date of the month to retrieve statistics for. Must be formatted YYYY-MM-DD",
          "required": true
        },
        {
          "name": "subuser",
          "type": "string",
          "location": "query",
          "description": "A substring search of your subusers."
        },
        {
          "name": "sort_by_metric",
          "type": "string",
          "location": "query",
          "description": "The metric that you want to sort by. Metrics that you can sort by are: `blocks`, `bounces`, `clicks`, `delivered`, `opens`, `requests`, `unique_clicks`, `unique_opens`, and `unsubscribes`.'"
        },
        {
          "name": "sort_by_direction",
          "type": "string",
          "location": "query",
          "description": "The direction you want to sort."
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "Optional field to limit the number of results returned."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "Optional beginning point in the list to retrieve from."
        }
      ]
    },
    {
      "name": "subusers_list-reputation",
      "description": "**This endpoint allows you to request the reputations for your subusers.** Subuser sender reputations give a good idea how well a sender is doing with regards to how recipients and recipient servers react to the mail that is being received. When a bounce, spam report, or other negative action happens on a sent email, it will affect your sender rating. For Regional (EU) subusers, subuser reputation scores will not calculate accurately due to restrictions in place to maintain data residency. Optional: usernames. Returns array of SubusersListReputationItem.",
      "method": "GET",
      "path": "/v3/subusers/reputations",
      "params": [
        {
          "name": "usernames",
          "type": "string",
          "location": "query",
          "description": "Usernames"
        }
      ]
    },
    {
      "name": "subusers_list-stat",
      "description": "**This endpoint allows you to retrieve the email statistics for the given subusers.** You may retrieve statistics for up to 10 different subusers by including an additional _subusers_ parameter for each additional subuser. Required: subusers, start_date. Optional: limit, offset, aggregated_by (plus 1 more). Returns array of CategoryStats.",
      "method": "GET",
      "path": "/v3/subusers/stats",
      "params": [
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "Limits the number of results returned per page."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The point in the list to begin retrieving results from."
        },
        {
          "name": "aggregated_by",
          "type": "string",
          "location": "query",
          "description": "How to group the statistics. Must be either 'day', 'week', or 'month'."
        },
        {
          "name": "subusers",
          "type": "string",
          "location": "query",
          "description": "The subuser you want to retrieve statistics for. You may include this parameter up to 10 times to retrieve statistics for multiple subusers.",
          "required": true
        },
        {
          "name": "start_date",
          "type": "string",
          "location": "query",
          "description": "The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.",
          "required": true
        },
        {
          "name": "end_date",
          "type": "string",
          "location": "query",
          "description": "The end date of the statistics to retrieve. Defaults to today."
        }
      ]
    },
    {
      "name": "subusers_list-stat-sum",
      "description": "**This endpoint allows you to retrieve the total sums of each email statistic metric for all subusers over the given date range.**. Required: start_date. Optional: sort_by_direction (default: desc), end_date, limit (default: 5) (plus 3 more). Returns the CategoryStats.",
      "method": "GET",
      "path": "/v3/subusers/stats/sums",
      "params": [
        {
          "name": "sort_by_direction",
          "type": "string",
          "location": "query",
          "description": "The direction you want to sort."
        },
        {
          "name": "start_date",
          "type": "string",
          "location": "query",
          "description": "The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.",
          "required": true
        },
        {
          "name": "end_date",
          "type": "string",
          "location": "query",
          "description": "The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD."
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "Limits the number of results returned per page."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The point in the list to begin retrieving results from."
        },
        {
          "name": "aggregated_by",
          "type": "string",
          "location": "query",
          "description": "How to group the statistics. Defaults to today. Must follow format YYYY-MM-DD."
        },
        {
          "name": "sort_by_metric",
          "type": "string",
          "location": "query",
          "description": "The metric that you want to sort by. Must be a single metric."
        }
      ]
    },
    {
      "name": "subusers_update",
      "description": "**This endpoint allows you to enable or disable a subuser.**. Required: subuser_name. Optional: disabled. Partial update.",
      "method": "PATCH",
      "path": "/v3/subusers/{subuser_name}",
      "params": [
        {
          "name": "subuser_name",
          "type": "string",
          "location": "path",
          "description": "The username of the Subuser.",
          "required": true
        },
        {
          "name": "disabled",
          "type": "bool",
          "location": "body",
          "description": "Whether or not this subuser is disabled. `true` means disabled, `false` means enabled."
        }
      ]
    },
    {
      "name": "subusers_credits_get-subuser",
      "description": "**This endpoint allows you to retrieve a Credits overview for a Subuser.**. Required: subuser_name. Returns the SubuserCredits.",
      "method": "GET",
      "path": "/v3/subusers/{subuser_name}/credits",
      "params": [
        {
          "name": "subuser_name",
          "type": "string",
          "location": "path",
          "description": "The username of the Subuser.",
          "required": true
        }
      ]
    },
    {
      "name": "subusers_credits_update-subuser",
      "description": "**This endpoint allows you to update the Credits for a Subuser.**. Required: subuser_name, type. Optional: reset_frequency, total. Returns the updated SubuserCredits.",
      "method": "PUT",
      "path": "/v3/subusers/{subuser_name}/credits",
      "params": [
        {
          "name": "subuser_name",
          "type": "string",
          "location": "path",
          "description": "The username of the Subuser.",
          "required": true
        },
        {
          "name": "reset_frequency",
          "type": "string",
          "location": "body",
          "description": "The frequency with which a Subuser's credits are reset if `type` is set to `recurring`. Do _not_ include `reset_frequency` if you choose a reset `type` value of `unlimited` or `nonrecurring`."
        },
        {
          "name": "total",
          "type": "int",
          "location": "body",
          "description": "Total number of credits to which the Subuser is to be reset. If `type` is `nonrecurring` then the Subuser's credits will be reset to `total` on a one-time basis. If `type` is `recurring` then the Subuser's credits will be reset to `total` every time a reset is scheduled in accordance with the `reset_frequency`. Do _not_ include `total` if you choose a reset `type` value of `unlimited`."
        },
        {
          "name": "type",
          "type": "string",
          "location": "body",
          "description": "Type determines how credits are reset for a Subuser. `unlimited` indicates that there is no limit to the Subuser's credits. `recurring` indicates that the credits for the Subuser are reset according to the frequency determined by `reset_frequency`. `nonrecurring` indicates that there is no recurring schedule to reset credits and resets must be done on an ad hoc basis.",
          "required": true
        }
      ]
    },
    {
      "name": "subusers_credits_update-subuser-remaining",
      "description": "**This endpoint allows you to update the remaining credits for a Subuser.**. Required: subuser_name, allocation_update. Returns the updated SubuserCredits.",
      "method": "PATCH",
      "path": "/v3/subusers/{subuser_name}/credits/remaining",
      "params": [
        {
          "name": "subuser_name",
          "type": "string",
          "location": "path",
          "description": "The username of the Subuser.",
          "required": true
        },
        {
          "name": "allocation_update",
          "type": "int",
          "location": "body",
          "description": "The number of credits to add to or subtract from the current remaining credits for the Subuser. Use a positive number to increase the remaining credits or a negative number to reduce the remaining credits.",
          "required": true
        }
      ]
    },
    {
      "name": "subusers_ips_update-subuser",
      "description": "**This endpoint allows you update your subusers' assigned IP.** Each subuser should be assigned to an IP address from which all of this subuser's mail will be sent. Often, this is the same IP as the parent account, but each subuser can have one or more of their own IP addresses as well. More information: * [How to request more IPs](https://sendgrid.com/docs/ui/account-and-settings/dedicated-ip-addresses/) * [Setup Reverse DNS](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-reverse-dns/). Required: subuser_name. Returns the updated IpsUpdateSubuserResponse.",
      "method": "PUT",
      "path": "/v3/subusers/{subuser_name}/ips",
      "params": [
        {
          "name": "subuser_name",
          "type": "string",
          "location": "path",
          "description": "The username of the Subuser.",
          "required": true
        }
      ]
    },
    {
      "name": "subusers_stats_list-subuser-monthly",
      "description": "**This endpoint allows you to retrive the monthly email statistics for a specific subuser.** When using the `sort_by_metric` to sort your stats by a specific metric, you can not sort by the following metrics: `bounce_drops`, `deferred`, `invalid_emails`, `processed`, `spam_report_drops`, `spam_reports`, or `unsubscribe_drops`. Required: subuser_name, date. Optional: sort_by_metric (default: delivered), sort_by_direction (default: desc), limit (default: 5) (plus 1 more). Returns the SubuserStats.",
      "method": "GET",
      "path": "/v3/subusers/{subuser_name}/stats/monthly",
      "params": [
        {
          "name": "subuser_name",
          "type": "string",
          "location": "path",
          "description": "The username of the Subuser.",
          "required": true
        },
        {
          "name": "date",
          "type": "string",
          "location": "query",
          "description": "The date of the month to retrieve statistics for. Must be formatted YYYY-MM-DD",
          "required": true
        },
        {
          "name": "sort_by_metric",
          "type": "string",
          "location": "query",
          "description": "The metric that you want to sort by. Metrics that you can sort by are: `blocks`, `bounces`, `clicks`, `delivered`, `opens`, `requests`, `unique_clicks`, `unique_opens`, and `unsubscribes`.'"
        },
        {
          "name": "sort_by_direction",
          "type": "string",
          "location": "query",
          "description": "The direction you want to sort."
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "Optional field to limit the number of results returned."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "Optional beginning point in the list to retrieve from."
        }
      ]
    },
    {
      "name": "subusers_website-access_update-subuser",
      "description": "Enable/Disable website access for a Subuser, while still preserving email send functionality. Required: subuser_name. Optional: disabled. Partial update.",
      "method": "PATCH",
      "path": "/v3/subusers/{subuser_name}/website_access",
      "params": [
        {
          "name": "subuser_name",
          "type": "string",
          "location": "path",
          "description": "Subuser name",
          "required": true
        },
        {
          "name": "disabled",
          "type": "bool",
          "location": "body",
          "description": "Whether or not to disable website access to the Subuser. `true` means disabled, `false` means enabled."
        }
      ]
    },
    {
      "name": "suppression_delete-block",
      "description": "**This endpoint allows you to delete a specific email address from your blocks list.**. Required: email. Destructive.",
      "method": "DELETE",
      "path": "/v3/suppression/blocks/{email}",
      "params": [
        {
          "name": "email",
          "type": "string",
          "location": "path",
          "description": "The email address of the specific block.",
          "required": true
        }
      ]
    },
    {
      "name": "suppression_delete-blocks",
      "description": "**This endpoint allows you to delete all email addresses on your blocks list.** There are two options for deleting blocked emails: 1. You can delete all blocked emails by setting `delete_all` to `true` in the request body. 2. You can delete a selection of blocked emails by specifying the email addresses in the `emails` array of the request body. Optional: delete_all, emails. Destructive.",
      "method": "DELETE",
      "path": "/v3/suppression/blocks",
      "params": [
        {
          "name": "delete_all",
          "type": "bool",
          "location": "body",
          "description": "Indicates if you want to delete all blocked email addresses."
        },
        {
          "name": "emails",
          "type": "array",
          "location": "body",
          "description": "The specific blocked email addresses that you want to delete."
        }
      ]
    },
    {
      "name": "suppression_delete-bounce",
      "description": "**This endpoint allows you to remove an email address from your bounce list.**. Required: email. Destructive.",
      "method": "DELETE",
      "path": "/v3/suppression/bounces/{email}",
      "params": [
        {
          "name": "email",
          "type": "string",
          "location": "path",
          "description": "The email address you would like to remove from the bounce list.",
          "required": true
        }
      ]
    },
    {
      "name": "suppression_delete-bounces",
      "description": "**This endpoint allows you to delete all emails on your bounces list.** There are two options for deleting bounced emails: 1. You can delete all bounced emails by setting `delete_all` to `true` in the request body. 2. You can delete a selection of bounced emails by specifying the email addresses in the `emails` array of the request body. **WARNING:** You can not have both `emails` and `delete_all` set. Optional: delete_all, emails. Destructive.",
      "method": "DELETE",
      "path": "/v3/suppression/bounces",
      "params": [
        {
          "name": "delete_all",
          "type": "bool",
          "location": "body",
          "description": "This parameter allows you to delete **every** email in your bounce list. This should not be used with the emails parameter."
        },
        {
          "name": "emails",
          "type": "array",
          "location": "body",
          "description": "Delete multiple emails from your bounce list at the same time. This should not be used with the delete_all parameter."
        }
      ]
    },
    {
      "name": "suppression_delete-invalid-email",
      "description": "**This endpoint allows you to remove a specific email address from the invalid email address list.**. Required: email. Destructive.",
      "method": "DELETE",
      "path": "/v3/suppression/invalid_emails/{email}",
      "params": [
        {
          "name": "email",
          "type": "string",
          "location": "path",
          "description": "The specific email address of the invalid email entry that you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "suppression_delete-invalid-emails",
      "description": "**This endpoint allows you to remove email addresses from your invalid email address list.** There are two options for deleting invalid email addresses: 1) You can delete all invalid email addresses by setting `delete_all` to true in the request body. 2) You can delete some invalid email addresses by specifying certain addresses in an array in the request body. Optional: delete_all, emails. Destructive.",
      "method": "DELETE",
      "path": "/v3/suppression/invalid_emails",
      "params": [
        {
          "name": "delete_all",
          "type": "bool",
          "location": "body",
          "description": "Indicates if you want to remove all email address from the invalid emails list."
        },
        {
          "name": "emails",
          "type": "array",
          "location": "body",
          "description": "The list of specific email addresses that you want to remove."
        }
      ]
    },
    {
      "name": "suppression_delete-spam-report",
      "description": "**This endpoint allows you to delete a specific spam report by email address.** Deleting a spam report will remove the suppression, meaning email will once again be sent to the previously suppressed address. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our [bypass filters](https://sendgrid.com/docs/ui/sending-email/index-suppressions/#bypass-suppressions) to deliver messages to otherwise suppressed addresses when exceptions are required. Required: email. Destructive.",
      "method": "DELETE",
      "path": "/v3/suppression/spam_reports/{email}",
      "params": [
        {
          "name": "email",
          "type": "string",
          "location": "path",
          "description": "The email address of a specific spam report that you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "suppression_delete-spam-reports",
      "description": "**This endpoint allows you to delete your spam reports.** Deleting a spam report will remove the suppression, meaning email will once again be sent to the previously suppressed address. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our [bypass filters](https://sendgrid.com/docs/ui/sending-email/index-suppressions/#bypass-suppressions) to deliver messages to otherwise suppressed addresses when exceptions are required. There are two options for deleting spam reports: 1. You can delete all spam reports by setting the `delete_all` field to `true` in the request body. 2. You can delete a list of select spam reports by specifying the email addresses in the `emails` array of the request body. Optional: delete_all, emails. Destructive.",
      "method": "DELETE",
      "path": "/v3/suppression/spam_reports",
      "params": [
        {
          "name": "delete_all",
          "type": "bool",
          "location": "body",
          "description": "Indicates if you want to delete all email addresses on the spam report list."
        },
        {
          "name": "emails",
          "type": "array",
          "location": "body",
          "description": "A list of specific email addresses that you want to remove from the spam report list."
        }
      ]
    },
    {
      "name": "suppression_get-block",
      "description": "**This endpoint allows you to retrieve a specific email address from your blocks list.**. Required: email. Returns array of SuppressionGetBlockItem.",
      "method": "GET",
      "path": "/v3/suppression/blocks/{email}",
      "params": [
        {
          "name": "email",
          "type": "string",
          "location": "path",
          "description": "The email address of the specific block.",
          "required": true
        }
      ]
    },
    {
      "name": "suppression_get-bounces",
      "description": "**This endpoint allows you to retrieve a specific bounce by email address.**. Required: email. Returns array of BounceResponse.",
      "method": "GET",
      "path": "/v3/suppression/bounces/{email}",
      "params": [
        {
          "name": "email",
          "type": "string",
          "location": "path",
          "description": "The email address of the specific bounce you would like to retrieve",
          "required": true
        }
      ]
    },
    {
      "name": "suppression_get-bounces-classifications",
      "description": "This endpoint will return the number of bounces for the classification specified in descending order for each day. You can retrieve the bounce classification totals in CSV format by specifying `'text/csv'` in the Accept header. Required: classification (default: Content). Optional: start_date, end_date. Returns the SuppressionGetBouncesClassificationsResponse.",
      "method": "GET",
      "path": "/v3/suppression/bounces/classifications/{classification}",
      "params": [
        {
          "name": "classification",
          "type": "string",
          "location": "path",
          "description": "The classification you want to filter by. Possible values are: `Content`, `Frequency or Volume Too High`, `Invalid Address`, `Mailbox Unavailable`, `Reputation`, `Technical Failure`, `Unclassified`."
        },
        {
          "name": "start_date",
          "type": "string",
          "location": "query",
          "description": "The start of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive)."
        },
        {
          "name": "end_date",
          "type": "string",
          "location": "query",
          "description": "The end of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive)."
        }
      ]
    },
    {
      "name": "suppression_get-invalid-email",
      "description": "**This endpoint allows you to retrieve a specific invalid email addresses.**. Required: email. Returns array of InvalidEmail.",
      "method": "GET",
      "path": "/v3/suppression/invalid_emails/{email}",
      "params": [
        {
          "name": "email",
          "type": "string",
          "location": "path",
          "description": "The specific email address of the invalid email entry that you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "suppression_get-spam-report",
      "description": "**This endpoint allows you to retrieve a specific spam report by email address.**. Required: email. Returns array of SuppressionGetSpamReportItem.",
      "method": "GET",
      "path": "/v3/suppression/spam_reports/{email}",
      "params": [
        {
          "name": "email",
          "type": "string",
          "location": "path",
          "description": "The email address of a specific spam report that you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "suppression_list-block",
      "description": "**This endpoint allows you to retrieve a paginated list of all email addresses that are currently on your blocks list.** You can use the `limit` query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the `offset` query parameter to control the position in the list from which to start retrieving additional items. Optional: start_time, end_time, limit (plus 2 more). Returns array of SuppressionListBlockItem.",
      "method": "GET",
      "path": "/v3/suppression/blocks",
      "params": [
        {
          "name": "start_time",
          "type": "int",
          "location": "query",
          "description": "The start of the time range when a blocked email was created (inclusive). This is a unix timestamp."
        },
        {
          "name": "end_time",
          "type": "int",
          "location": "query",
          "description": "The end of the time range when a blocked email was created (inclusive). This is a unix timestamp."
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "`limit` sets the page size, i."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The number of items in the list to skip over before starting to retrieve the items for the..."
        },
        {
          "name": "email",
          "type": "string",
          "location": "query",
          "description": "Specifies which records to return based on the records' associated email addresses."
        }
      ]
    },
    {
      "name": "suppression_list-bounces",
      "description": "**This endpoint allows you to retrieve a paginated list of all your bounces.** You can use the `limit` query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the `offset` query parameter to control the position in the list from which to start retrieving additional items. Optional: start_time, end_time, limit (plus 2 more). Returns array of BounceResponse.",
      "method": "GET",
      "path": "/v3/suppression/bounces",
      "params": [
        {
          "name": "start_time",
          "type": "int",
          "location": "query",
          "description": "Refers start of the time range in unix timestamp when a bounce was created (inclusive)."
        },
        {
          "name": "end_time",
          "type": "int",
          "location": "query",
          "description": "Refers end of the time range in unix timestamp when a bounce was created (inclusive)."
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "`limit` sets the page size, i."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The number of items in the list to skip over before starting to retrieve the items for the..."
        },
        {
          "name": "email",
          "type": "string",
          "location": "query",
          "description": "Specifies which records to return based on the records' associated email addresses."
        }
      ]
    },
    {
      "name": "suppression_list-bounces-classifications",
      "description": "This endpoint will return the total number of bounces by classification in descending order for each day. You can retrieve the bounce classification totals in CSV format by specifying `'text/csv'` in the Accept header. Optional: start_date, end_date. Returns the SuppressionListBouncesClassificationsResponse.",
      "method": "GET",
      "path": "/v3/suppression/bounces/classifications",
      "params": [
        {
          "name": "start_date",
          "type": "string",
          "location": "query",
          "description": "The start of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive)."
        },
        {
          "name": "end_date",
          "type": "string",
          "location": "query",
          "description": "The end of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive)."
        }
      ]
    },
    {
      "name": "suppression_list-global",
      "description": "**This endpoint allows you to retrieve a paginated list of all email address that are globally suppressed.** You can use the `limit` query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the `offset` query parameter to control the position in the list from which to start retrieving additional items. Optional: start_time, end_time, limit (plus 2 more). Returns array of SuppressionListGlobalItem.",
      "method": "GET",
      "path": "/v3/suppression/unsubscribes",
      "params": [
        {
          "name": "start_time",
          "type": "int",
          "location": "query",
          "description": "Refers start of the time range in unix timestamp when an unsubscribe email was created (inclusive)."
        },
        {
          "name": "end_time",
          "type": "int",
          "location": "query",
          "description": "Refers end of the time range in unix timestamp when an unsubscribe email was created (inclusive)."
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "`limit` sets the page size, i."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The number of items in the list to skip over before starting to retrieve the items for the..."
        },
        {
          "name": "email",
          "type": "string",
          "location": "query",
          "description": "Specifies which records to return based on the records' associated email addresses."
        }
      ]
    },
    {
      "name": "suppression_list-invalid-email",
      "description": "**This endpoint allows you to retrieve a paginated list of all invalid email addresses.** You can use the `limit` query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the `offset` query parameter to control the position in the list from which to start retrieving additional items. Optional: start_time, end_time, limit (plus 2 more). Returns array of InvalidEmail.",
      "method": "GET",
      "path": "/v3/suppression/invalid_emails",
      "params": [
        {
          "name": "start_time",
          "type": "int",
          "location": "query",
          "description": "Refers start of the time range in unix timestamp when an invalid email was created (inclusive)."
        },
        {
          "name": "end_time",
          "type": "int",
          "location": "query",
          "description": "Refers end of the time range in unix timestamp when an invalid email was created (inclusive)."
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "`limit` sets the page size, i."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The number of items in the list to skip over before starting to retrieve the items for the..."
        },
        {
          "name": "email",
          "type": "string",
          "location": "query",
          "description": "This parameter allows you to filter results by email address. Only invalid addresses matching an address passed in this parameter will be returned."
        }
      ]
    },
    {
      "name": "suppression_list-spam-report",
      "description": "**This endpoint allows you to retrieve a paginated list of all spam reports.** You can use the `limit` query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the `offset` query parameter to control the position in the list from which to start retrieving additional items. Optional: start_time, end_time, limit (plus 2 more). Returns array of SuppressionListSpamReportItem.",
      "method": "GET",
      "path": "/v3/suppression/spam_reports",
      "params": [
        {
          "name": "start_time",
          "type": "int",
          "location": "query",
          "description": "The start of the time range when a spam report was created (inclusive). This is a unix timestamp."
        },
        {
          "name": "end_time",
          "type": "int",
          "location": "query",
          "description": "The end of the time range when a spam report was created (inclusive). This is a unix timestamp."
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "`limit` sets the page size, i."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The number of items in the list to skip over before starting to retrieve the items for the..."
        },
        {
          "name": "email",
          "type": "string",
          "location": "query",
          "description": "Specifies which records to return based on the records' associated email addresses."
        }
      ]
    },
    {
      "name": "teammates_delete",
      "description": "**This endpoint allows you to delete a teammate.** **Only the parent user or an admin teammate can delete another teammate.**. Required: username. Destructive.",
      "method": "DELETE",
      "path": "/v3/teammates/{username}",
      "params": [
        {
          "name": "username",
          "type": "string",
          "location": "path",
          "description": "The username of the teammate that you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "teammates_delete-pending",
      "description": "**This endpoint allows you to delete a pending teammate invite.**. Required: token. Destructive.",
      "method": "DELETE",
      "path": "/v3/teammates/pending/{token}",
      "params": [
        {
          "name": "token",
          "type": "string",
          "location": "path",
          "description": "The token for the invite you want to delete.",
          "required": true
        }
      ]
    },
    {
      "name": "teammates_get",
      "description": "**This endpoint allows you to retrieve a specific Teammate by username.** You can retrieve the username's for each of your Teammates using the 'Retrieve all Teammates' endpoint. Required: username. Returns the TeammatesGetResponse.",
      "method": "GET",
      "path": "/v3/teammates/{username}",
      "params": [
        {
          "name": "username",
          "type": "string",
          "location": "path",
          "description": "The username of the teammate that you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "teammates_invite",
      "description": "**This endpoint allows you to invite a Teammate to your account via email.** You can set a Teammate's initial permissions using the `scopes` array in the request body. Teammate's will receive a minimum set of scopes from Twilio SendGrid that are necessary for the Teammate to function. **Note:** A teammate invite will expire after 7 days, but you may resend the invitation at any time to reset the expiration date. Required: email, is_admin (default: false), scopes. Returns the new TeammatesInviteResponse.",
      "method": "POST",
      "path": "/v3/teammates",
      "params": [
        {
          "name": "email",
          "type": "string",
          "location": "body",
          "description": "New teammate's email",
          "required": true
        },
        {
          "name": "is_admin",
          "type": "bool",
          "location": "body",
          "description": "Set to true if teammate should be an admin user",
          "required": true
        },
        {
          "name": "scopes",
          "type": "array",
          "location": "body",
          "description": "Set to specify list of scopes that teammate should have. Should be empty if teammate is an admin.",
          "required": true
        }
      ]
    },
    {
      "name": "teammates_list",
      "description": "**This endpoint allows you to retrieve a paginated list of all current Teammates.** You can use the `limit` query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the `offset` query parameter to control the position in the list from which to start retrieving additional items. Optional: limit (default: 500), offset (default: 0). Returns the TeammatesListResponse.",
      "method": "GET",
      "path": "/v3/teammates",
      "params": [
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "`limit` sets the page size, i."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The number of items in the list to skip over before starting to retrieve the items for the..."
        }
      ]
    },
    {
      "name": "teammates_list-pending",
      "description": "**This endpoint allows you to retrieve a list of all pending Teammate invitations.** Each teammate invitation is valid for 7 days. Users may resend the invitation to refresh the expiration date. Returns the TeammatesListPendingResponse.",
      "method": "GET",
      "path": "/v3/teammates/pending",
      "params": []
    },
    {
      "name": "teammates_resend-invite",
      "description": "**This endpoint allows you to resend a Teammate invitation.** Teammate invitations will expire after 7 days. Resending an invitation will reset the expiration date. Required: token. Returns the new TeammatesResendInviteResponse.",
      "method": "POST",
      "path": "/v3/teammates/pending/{token}/resend",
      "params": [
        {
          "name": "token",
          "type": "string",
          "location": "path",
          "description": "The token for the invite that you want to resend.",
          "required": true
        }
      ]
    },
    {
      "name": "teammates_update",
      "description": "**This endpoint allows you to update a teammate’s permissions.** To turn a teammate into an admin, the request body should contain an `is_admin` set to `true`. Otherwise, set `is_admin` to `false` and pass in all the scopes that a teammate should have. **Only the parent user or other admin teammates can update another teammate’s permissions.** **Admin users can only update permissions.**. Required: username, is_admin, scopes. Returns the updated TeammatesUpdateResponse.",
      "method": "PATCH",
      "path": "/v3/teammates/{username}",
      "params": [
        {
          "name": "username",
          "type": "string",
          "location": "path",
          "description": "The username of the teammate that you want to retrieve.",
          "required": true
        },
        {
          "name": "is_admin",
          "type": "bool",
          "location": "body",
          "description": "Set to True if this teammate should be promoted to an admin user. If True, scopes should be an empty array.",
          "required": true
        },
        {
          "name": "scopes",
          "type": "array",
          "location": "body",
          "description": "Provide list of scopes that should be given to teammate. If specifying list of scopes, is_admin should be set to False.",
          "required": true
        }
      ]
    },
    {
      "name": "teammates_subuser-access_list-subuser-by-template",
      "description": "**This operation allows you to retrieve the Subusers that can be accessed by a specified Teammate.** This operation will return the Subusers available to a Teammate, including the scopes available. If the Teammate is an administrator, all Subusers will be returned. Required: teammate_name. Optional: after_subuser_id, limit (default: 100), username. Returns the SubuserAccessListSubuserByTemplateResponse.",
      "method": "GET",
      "path": "/v3/teammates/{teammate_name}/subuser_access",
      "params": [
        {
          "name": "teammate_name",
          "type": "string",
          "location": "path",
          "description": "The username of the Teammate for whom you want to retrieve Subuser access information.",
          "required": true
        },
        {
          "name": "after_subuser_id",
          "type": "int",
          "location": "query",
          "description": "The Subuser ID from which the API request will begin retrieving Subusers. This query parameter can be used in successive API calls to retrieve additional Subusers."
        },
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "Limit the number of Subusers to be returned. The default `limit` is `100` per request."
        },
        {
          "name": "username",
          "type": "string",
          "location": "query",
          "description": "A Subuser's username that will be used to filter the returned result."
        }
      ]
    },
    {
      "name": "templates_create",
      "description": "**This endpoint allows you to create a transactional template.**. Required: name. Optional: generation (default: legacy). Returns the new TransactionalTemplate.",
      "method": "POST",
      "path": "/v3/templates",
      "params": [
        {
          "name": "generation",
          "type": "string",
          "location": "body",
          "description": "Defines whether the template supports dynamic replacement."
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The name for the new transactional template.",
          "required": true
        }
      ]
    },
    {
      "name": "templates_delete",
      "description": "**This endpoint allows you to delete a transactional template.**. Required: template_id. Destructive.",
      "method": "DELETE",
      "path": "/v3/templates/{template_id}",
      "params": [
        {
          "name": "template_id",
          "type": "string",
          "location": "path",
          "description": "Template id",
          "required": true
        }
      ]
    },
    {
      "name": "templates_duplicate",
      "description": "**This endpoint allows you to duplicate a transactional template.**. Required: template_id. Optional: name. Returns the new TransactionalTemplate.",
      "method": "POST",
      "path": "/v3/templates/{template_id}",
      "params": [
        {
          "name": "template_id",
          "type": "string",
          "location": "path",
          "description": "Template id",
          "required": true
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The name for the new transactional template."
        }
      ]
    },
    {
      "name": "templates_get",
      "description": "**This endpoint allows you to retrieve a single transactional template.**. Required: template_id. Returns the TransactionalTemplate.",
      "method": "GET",
      "path": "/v3/templates/{template_id}",
      "params": [
        {
          "name": "template_id",
          "type": "string",
          "location": "path",
          "description": "Template id",
          "required": true
        }
      ]
    },
    {
      "name": "templates_list",
      "description": "**This endpoint allows you to retrieve all transactional templates.**. Required: page_size. Optional: generations (default: legacy), page_token. Returns the TemplatesListResponse.",
      "method": "GET",
      "path": "/v3/templates",
      "params": [
        {
          "name": "generations",
          "type": "string",
          "location": "query",
          "description": "Comma-delimited list specifying which generations of templates to return. Options are `legacy`, `dynamic` or `legacy,dynamic`."
        },
        {
          "name": "page_size",
          "type": "float",
          "location": "query",
          "description": "The number of templates to be returned in each page of results",
          "required": true
        },
        {
          "name": "page_token",
          "type": "string",
          "location": "query",
          "description": "A token corresponding to a specific page of results, as provided by metadata"
        }
      ]
    },
    {
      "name": "templates_update",
      "description": "**This endpoint allows you to edit the name of a transactional template.** To edit the template itself, [create a new transactional template version](https://docs.sendgrid.com/api-reference/transactional-templates-versions/create-a-new-transactional-template-version). Required: template_id. Optional: name. Returns the updated TransactionalTemplate.",
      "method": "PATCH",
      "path": "/v3/templates/{template_id}",
      "params": [
        {
          "name": "template_id",
          "type": "string",
          "location": "path",
          "description": "Template id",
          "required": true
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "The name of the transactional template."
        }
      ]
    },
    {
      "name": "templates_versions_activate-template",
      "description": "**This endpoint allows you to activate a version of one of your templates.**. Required: template_id, version_id. Returns the new TransactionalTemplateVersionOutput.",
      "method": "POST",
      "path": "/v3/templates/{template_id}/versions/{version_id}/activate",
      "params": [
        {
          "name": "template_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the original template",
          "required": true
        },
        {
          "name": "version_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the template version",
          "required": true
        }
      ]
    },
    {
      "name": "templates_versions_create-template",
      "description": "**This endpoint allows you to create a new version of a template.**. Required: template_id, name, subject. Optional: active, editor, generate_plain_content (default: true) (plus 3 more). Returns the new TransactionalTemplateVersionOutput.",
      "method": "POST",
      "path": "/v3/templates/{template_id}/versions",
      "params": [
        {
          "name": "template_id",
          "type": "string",
          "location": "path",
          "description": "Template id",
          "required": true
        },
        {
          "name": "active",
          "type": "int",
          "location": "body",
          "description": "Set the version as the active version associated with the template (0 is inactive, 1 is active). Only one version of a template can be active. The first version created for a template will automatically be set to Active."
        },
        {
          "name": "editor",
          "type": "string",
          "location": "body",
          "description": "The editor used in the UI."
        },
        {
          "name": "generate_plain_content",
          "type": "bool",
          "location": "body",
          "description": "If true, plain_content is always generated from html_content."
        },
        {
          "name": "html_content",
          "type": "string",
          "location": "body",
          "description": "The HTML content of the version. Maximum of 1048576 bytes allowed."
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "Name of the transactional template version.",
          "required": true
        },
        {
          "name": "plain_content",
          "type": "string",
          "location": "body",
          "description": "Text/plain content of the transactional template version. Maximum of 1048576 bytes allowed."
        },
        {
          "name": "subject",
          "type": "string",
          "location": "body",
          "description": "Subject of the new transactional template version.",
          "required": true
        },
        {
          "name": "test_data",
          "type": "string",
          "location": "body",
          "description": "For dynamic templates only, the mock json data that will be used for template preview and test sends."
        }
      ]
    },
    {
      "name": "templates_versions_delete-template",
      "description": "**This endpoint allows you to delete a transactional template version.**. Required: template_id, version_id. Destructive.",
      "method": "DELETE",
      "path": "/v3/templates/{template_id}/versions/{version_id}",
      "params": [
        {
          "name": "template_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the original template",
          "required": true
        },
        {
          "name": "version_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the template version",
          "required": true
        }
      ]
    },
    {
      "name": "templates_versions_get-template",
      "description": "**This endpoint allows you to retrieve a specific version of a template.**. Required: template_id, version_id. Returns the TransactionalTemplateVersionOutput.",
      "method": "GET",
      "path": "/v3/templates/{template_id}/versions/{version_id}",
      "params": [
        {
          "name": "template_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the original template",
          "required": true
        },
        {
          "name": "version_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the template version",
          "required": true
        }
      ]
    },
    {
      "name": "templates_versions_update-template",
      "description": "**This endpoint allows you to edit the content of your template version.**. Required: template_id, version_id, name, subject. Optional: active, editor, generate_plain_content (default: true) (plus 3 more). Returns the updated TransactionalTemplateVersionOutput.",
      "method": "PATCH",
      "path": "/v3/templates/{template_id}/versions/{version_id}",
      "params": [
        {
          "name": "template_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the original template",
          "required": true
        },
        {
          "name": "version_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the template version",
          "required": true
        },
        {
          "name": "active",
          "type": "int",
          "location": "body",
          "description": "Set the version as the active version associated with the template (0 is inactive, 1 is active). Only one version of a template can be active. The first version created for a template will automatically be set to Active."
        },
        {
          "name": "editor",
          "type": "string",
          "location": "body",
          "description": "The editor used in the UI."
        },
        {
          "name": "generate_plain_content",
          "type": "bool",
          "location": "body",
          "description": "If true, plain_content is always generated from html_content."
        },
        {
          "name": "html_content",
          "type": "string",
          "location": "body",
          "description": "The HTML content of the version. Maximum of 1048576 bytes allowed."
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "Name of the transactional template version.",
          "required": true
        },
        {
          "name": "plain_content",
          "type": "string",
          "location": "body",
          "description": "Text/plain content of the transactional template version. Maximum of 1048576 bytes allowed."
        },
        {
          "name": "subject",
          "type": "string",
          "location": "body",
          "description": "Subject of the new transactional template version.",
          "required": true
        },
        {
          "name": "test_data",
          "type": "string",
          "location": "body",
          "description": "For dynamic templates only, the mock json data that will be used for template preview and test sends."
        }
      ]
    },
    {
      "name": "tracking-settings_list",
      "description": "**This endpoint allows you to retrieve a list of all tracking settings on your account.**. Returns the TrackingSettingsListResponse.",
      "method": "GET",
      "path": "/v3/tracking_settings",
      "params": []
    },
    {
      "name": "tracking-settings_list-click",
      "description": "**This endpoint allows you to retrieve your current click tracking setting.** Click Tracking overrides all the links and URLs in your emails and points them to either SendGrid’s servers or the domain with which you branded your link. When a customer clicks a link, SendGrid tracks those [clicks](https://sendgrid.com/docs/glossary/clicks/). Click tracking helps you understand how users are engaging with your communications. SendGrid can track up to 1000 links per email. Returns the ClickTracking.",
      "method": "GET",
      "path": "/v3/tracking_settings/click",
      "params": []
    },
    {
      "name": "tracking-settings_list-google-analytics",
      "description": "**This endpoint allows you to retrieve your current setting for Google Analytics.** Google Analytics helps you understand how users got to your site and what they're doing there. For more information about using Google Analytics, please refer to [Google’s URL Builder](https://support.google.com/analytics/answer/1033867?hl=en) and their article on ['Best Practices for Campaign Building'](https://support.google.com/analytics/answer/1037445). We default the settings to Google’s recommendations. For more information, see [Google Analytics Demystified](https://sendgrid.com/docs/ui/analytics-and-reporting/google-analytics/). Returns the GoogleAnalyticsSettings.",
      "method": "GET",
      "path": "/v3/tracking_settings/google_analytics",
      "params": []
    },
    {
      "name": "tracking-settings_list-open",
      "description": "**This endpoint allows you to retrieve your current settings for open tracking.** Open Tracking adds an invisible image at the end of the email which can track email opens. If the email recipient has images enabled on their email client, a request to SendGrid’s server for the invisible image is executed and an open event is logged. These events are logged in the Statistics portal, Email Activity interface, and are reported by the Event Webhook. Returns the TrackingSettingsListOpenResponse.",
      "method": "GET",
      "path": "/v3/tracking_settings/open",
      "params": []
    },
    {
      "name": "tracking-settings_list-subscription",
      "description": "**This endpoint allows you to retrieve your current settings for subscription tracking.** Subscription tracking adds links to the bottom of your emails that allows your recipients to subscribe to, or unsubscribe from, your emails. Returns the SubscriptionTrackingSettings.",
      "method": "GET",
      "path": "/v3/tracking_settings/subscription",
      "params": []
    },
    {
      "name": "tracking-settings_update-click",
      "description": "**This endpoint allows you to enable or disable your current click tracking setting.** Click Tracking overrides all the links and URLs in your emails and points them to either SendGrid’s servers or the domain with which you branded your link. When a customer clicks a link, SendGrid tracks those [clicks](https://sendgrid.com/docs/glossary/clicks/). Click tracking helps you understand how users are engaging with your communications. SendGrid can track up to 1000 links per email. Optional: enabled. Returns the updated ClickTracking.",
      "method": "PATCH",
      "path": "/v3/tracking_settings/click",
      "params": [
        {
          "name": "enabled",
          "type": "bool",
          "location": "body",
          "description": "The setting you want to use for click tracking."
        }
      ]
    },
    {
      "name": "tracking-settings_update-google-analytics",
      "description": "**This endpoint allows you to update your current setting for Google Analytics.** Google Analytics helps you understand how users got to your site and what they're doing there. For more information about using Google Analytics, please refer to [Google’s URL Builder](https://support.google.com/analytics/answer/1033867?hl=en) and their article on ['Best Practices for Campaign Building'](https://support.google.com/analytics/answer/1037445). We default the settings to Google’s recommendations. For more information, see [Google Analytics Demystified](https://sendgrid.com/docs/ui/analytics-and-reporting/google-analytics/). Optional: enabled, utm_campaign, utm_content (plus 3 more). Returns the updated GoogleAnalyticsSettings.",
      "method": "PATCH",
      "path": "/v3/tracking_settings/google_analytics",
      "params": [
        {
          "name": "enabled",
          "type": "bool",
          "location": "body",
          "description": "Indicates if Google Analytics is enabled."
        },
        {
          "name": "utm_campaign",
          "type": "string",
          "location": "body",
          "description": "The name of the campaign."
        },
        {
          "name": "utm_content",
          "type": "string",
          "location": "body",
          "description": "Used to differentiate ads"
        },
        {
          "name": "utm_medium",
          "type": "string",
          "location": "body",
          "description": "Name of the marketing medium (e.g. 'Email')."
        },
        {
          "name": "utm_source",
          "type": "string",
          "location": "body",
          "description": "Name of the referrer source."
        },
        {
          "name": "utm_term",
          "type": "string",
          "location": "body",
          "description": "Any paid keywords."
        }
      ]
    },
    {
      "name": "tracking-settings_update-open",
      "description": "**This endpoint allows you to update your current settings for open tracking.** Open Tracking adds an invisible image at the end of the email which can track email opens. If the email recipient has images enabled on their email client, a request to SendGrid’s server for the invisible image is executed and an open event is logged. These events are logged in the Statistics portal, Email Activity interface, and are reported by the Event Webhook. Optional: enabled. Returns the updated TrackingSettingsUpdateOpenResponse.",
      "method": "PATCH",
      "path": "/v3/tracking_settings/open",
      "params": [
        {
          "name": "enabled",
          "type": "bool",
          "location": "body",
          "description": "The new status that you want to set for open tracking."
        }
      ]
    },
    {
      "name": "tracking-settings_update-subscription",
      "description": "**This endpoint allows you to update your current settings for subscription tracking.** Subscription tracking adds links to the bottom of your emails that allows your recipients to subscribe to, or unsubscribe from, your emails. Optional: enabled, html_content, landing (plus 3 more). Returns the updated SubscriptionTrackingSettings.",
      "method": "PATCH",
      "path": "/v3/tracking_settings/subscription",
      "params": [
        {
          "name": "enabled",
          "type": "bool",
          "location": "body",
          "description": "Indicates if subscription tracking is enabled."
        },
        {
          "name": "html_content",
          "type": "string",
          "location": "body",
          "description": "The information and HTML for your unsubscribe link."
        },
        {
          "name": "landing",
          "type": "string",
          "location": "body",
          "description": "The HTML that will be displayed on the page that your customers will see after clicking unsubscribe, hosted on SendGrid’s server."
        },
        {
          "name": "plain_content",
          "type": "string",
          "location": "body",
          "description": "The information in plain text for your unsubscribe link. You should have the “\u003c% %\u003e” tag in your content, otherwise the user will have no URL for unsubscribing."
        },
        {
          "name": "replace",
          "type": "string",
          "location": "body",
          "description": "Your custom defined replacement tag for your templates. Use this tag to place your unsubscribe content anywhere in your emailtemplate."
        },
        {
          "name": "url",
          "type": "string",
          "location": "body",
          "description": "The URL where you would like your users sent to unsubscribe."
        }
      ]
    },
    {
      "name": "user_create-event-webhook",
      "description": "**This endpoint allows you to create a new Event Webhook.** When creating a webhook, you will provide a URL where you want the webhook to send POST requests, and you will select which events you want to receive in those request. See the [**Event Webhook Reference**](https://docs.sendgrid.com/for-developers/tracking-events/event#delivery-events) for details about each event type. ### Webhook identifiers When your webhook is succesfully created, you will receive a webhook `id` in the response returned by this endpoint. You can use that ID to [update the webhook's settings](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook), [delete the webhook](https://docs.sendgrid.com/api-reference/webhooks/delete-an-event-webhook), [enable or disable signature verification for the webhook](https://docs.sendgrid.com/api-reference/webhooks/toggle-signature-verification-for-an-event-webhook), and, if signature verification is enabled, [retrieve the webhook's public key](https://docs.sendgrid.com/api-reference/webhooks/get-signed-event-webhooks-public-key). You may also assign an optional friendly name to each of your webhooks. The friendly name is for convenience only and should not be used to programmatically differentiate your webhooks because it does not need to be unique. Use the webhook ID to reliably differentiate among your webhooks. ### OAuth You can optionally configure OAuth verification for your webhook at the time of creation by passing the appropriate values in the `oauth_client_id`, `oauth_client_secret`, and `oauth_token_url` properties. You can enable or disable OAuth for the webhook after creation with the [**Update an Event Webhook**](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook) operation. You may share one OAuth configuration across all your webhooks or create unique credentials for each. See our [webhook security documentation](https://docs.sendgrid.com/for-developers/tracking-events/getting-started-event-webhook-security-features#oauth-20) for details about OAuth and the Event Webhook. ### Signature verification Enabling signature verification for your webhook is a separate process and cannot be done at the time of creation with this endpoint. You can use the webhook ID to [enable or disable signature verification with the endpoint dedicated for that operation](https://docs.sendgrid.com/api-reference/webhooks/toggle-signature-verification-for-an-event-webhook). Required: url. Optional: bounce, click, deferred (plus 13 more). Returns the new EventWebhookUnsignedResponse.",
      "method": "POST",
      "path": "/v3/user/webhooks/event/settings",
      "params": [
        {
          "name": "bounce",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive bounce events. A bounce occurs when a receiving server could not or would not accept a message."
        },
        {
          "name": "click",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive click events. Click events occur when a recipient clicks on a link within the message. You must [enable Click Tracking](https://docs.sendgrid.com/ui/account-and-settings/tracking#click-tracking) to receive this type of event."
        },
        {
          "name": "deferred",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive deferred events. Deferred events occur when a recipient's email server temporarily rejects a message."
        },
        {
          "name": "delivered",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive delivered events. Delivered events occur when a message has been successfully delivered to the receiving server."
        },
        {
          "name": "dropped",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive dropped events. Dropped events occur when your message is not delivered by Twilio SendGrid. Dropped events are accomponied by a `reason` property, which indicates why the message was dropped. Reasons for a dropped message include: Invalid SMTPAPI header, Spam Content (if spam checker app enabled), Unsubscribed Address, Bounced Address, Spam Reporting Address, Invalid, Recipient List over Package Quota."
        },
        {
          "name": "enabled",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to enable the Event Webhook or `false` to disable it."
        },
        {
          "name": "friendly_name",
          "type": "string",
          "location": "body",
          "description": "Optionally set this property to a friendly name for the Event Webhook. A friendly name may be assigned to each of your webhooks to help you differentiate them. The friendly name is for convenience only. You should use the webhook `id` property for any programmatic tasks."
        },
        {
          "name": "group_resubscribe",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive group resubscribe events. Group resubscribes occur when recipients resubscribe to a specific [unsubscribe group](https://docs.sendgrid.com/ui/sending-email/create-and-manage-unsubscribe-groups) by updating their subscription preferences. You must [enable Subscription Tracking](https://docs.sendgrid.com/ui/account-and-settings/tracking#subscription-tracking) to receive this type of event."
        },
        {
          "name": "group_unsubscribe",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive group unsubscribe events. Group unsubscribes occur when recipients unsubscribe from a specific [unsubscribe group](https://docs.sendgrid.com/ui/sending-email/create-and-manage-unsubscribe-groups) either by direct link or by updating their subscription preferences. You must [enable Subscription Tracking](https://docs.sendgrid.com/ui/account-and-settings/tracking#subscription-tracking) to receive this type of event."
        },
        {
          "name": "oauth_client_id",
          "type": "string",
          "location": "body",
          "description": "Set this property to the OAuth client ID that SendGrid will pass to your OAuth server or service provider to generate an OAuth access token. When passing data in this property, you must also include the `oauth_token_url` property."
        },
        {
          "name": "oauth_client_secret",
          "type": "string",
          "location": "body",
          "description": "Set this property to the OAuth client secret that SendGrid will pass to your OAuth server or service provider to generate an OAuth access token. This secret is needed only once to create an access token. SendGrid will store the secret, allowing you to update your client ID and Token URL without passing the secret to SendGrid again. When passing data in this field, you must also include the `oauth_client_id` and `oauth_token_url` properties."
        },
        {
          "name": "oauth_token_url",
          "type": "string",
          "location": "body",
          "description": "Set this property to the URL where SendGrid will send the OAuth client ID and client secret to generate an OAuth access token. This should be your OAuth server or service provider. When passing data in this field, you must also include the `oauth_client_id` property."
        },
        {
          "name": "open",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive open events. Open events occur when a recipient has opened the HTML message. You must [enable Open Tracking](https://docs.sendgrid.com/ui/account-and-settings/tracking#open-tracking) to receive this type of event."
        },
        {
          "name": "processed",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive processed events. Processed events occur when a message has been received by Twilio SendGrid and the message is ready to be delivered."
        },
        {
          "name": "spam_report",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive spam report events. Spam reports occur when recipients mark a message as spam."
        },
        {
          "name": "unsubscribe",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive unsubscribe events. Unsubscribes occur when recipients click on a message's subscription management link. You must [enable Subscription Tracking](https://docs.sendgrid.com/ui/account-and-settings/tracking#subscription-tracking) to receive this type of event."
        },
        {
          "name": "url",
          "type": "string",
          "location": "body",
          "description": "Set this property to the URL where you want the Event Webhook to send event data.",
          "required": true
        }
      ]
    },
    {
      "name": "user_create-parse-setting",
      "description": "**This endpoint allows you to create a new inbound parse setting.** Creating an Inbound Parse setting requires two pieces of information: a `url` and a `hostname`. The `hostname` must correspond to a domain authenticated by Twilio SendGrid on your account. If you need to complete domain authentication, you can use the [Twilio SendGrid App](https://app.sendgrid.com/settings/sender_auth) or the **Authenticate a Domain** endpoint. See [**How to Set Up Domain Authentication**](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-domain-authentication/) for instructions. Any email received by the `hostname` will be parsed when you complete this setup. You must also add a Twilio SendGrid MX record to this domain's DNS records. See [**Setting up the Inbound Parse Webhook**](https://sendgrid.com/docs/for-developers/parsing-email/setting-up-the-inbound-parse-webhook/) for full instructions. The `url` represents a location where the parsed message data will be delivered. Twilio SendGrid will make an HTTP POST request to this `url` with the message data. The `url` must be publicly reachable, and your application must return a `200` status code to signal that the message data has been received. Optional: hostname, send_raw, spam_check (plus 1 more). Returns the new ParseSetting.",
      "method": "POST",
      "path": "/v3/user/webhooks/parse/settings",
      "params": [
        {
          "name": "hostname",
          "type": "string",
          "location": "body",
          "description": "A specific and unique domain or subdomain that you have created to use exclusively to parse your incoming email. For example, `parse.yourdomain.com`."
        },
        {
          "name": "send_raw",
          "type": "bool",
          "location": "body",
          "description": "Indicates if you would like SendGrid to post the original MIME-type content of your parsed email. When this parameter is set to `true`, SendGrid will send a JSON payload of the content of your email."
        },
        {
          "name": "spam_check",
          "type": "bool",
          "location": "body",
          "description": "Indicates if you would like SendGrid to check the content parsed from your emails for spam before POSTing them to your domain."
        },
        {
          "name": "url",
          "type": "string",
          "location": "body",
          "description": "The public URL where you would like SendGrid to POST the data parsed from your email. Any emails sent with the given hostname provided (whose MX records have been updated to point to SendGrid) will be parsed and POSTed to this URL."
        }
      ]
    },
    {
      "name": "user_create-scheduled-send",
      "description": "**This endpoint allows you to cancel or pause a scheduled send associated with a `batch_id`.** Passing this endpoint a `batch_id` and status will cancel or pause the scheduled send. Once a scheduled send is set to `pause` or `cancel` you must use the 'Update a scheduled send' endpoint to change its status or the 'Delete a cancellation or pause from a scheduled send' endpoint to remove the status. Passing a status change to a scheduled send that has already been paused or cancelled will result in a `400` level status code. If the maximum number of cancellations/pauses are added to a send, a `400` level status code will be returned. Required: batch_id, status (default: pause). Returns the new ScheduledSendStatus.",
      "method": "POST",
      "path": "/v3/user/scheduled_sends",
      "params": [
        {
          "name": "batch_id",
          "type": "string",
          "location": "body",
          "description": "The batch ID is the identifier that your scheduled mail sends share.",
          "required": true
        },
        {
          "name": "status",
          "type": "string",
          "location": "body",
          "description": "The status of the send you would like to implement. This can be pause or cancel. To delete a pause or cancel status see DELETE /v3/user/scheduled_sends/{batch_id}",
          "required": true
        }
      ]
    },
    {
      "name": "user_create-security-policy",
      "description": "Create a new webhook security policy. Note: One of signature or oauth must be given to have a valid security policy. Optional: name, oauth, signature. Returns the new UserCreateSecurityPolicyResponse.",
      "method": "POST",
      "path": "/v3/user/webhooks/security/policies",
      "params": [
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "User-defined policy name"
        },
        {
          "name": "oauth",
          "type": "object",
          "location": "body",
          "description": "Oauth"
        },
        {
          "name": "signature",
          "type": "object",
          "location": "body",
          "description": "Signature"
        }
      ]
    },
    {
      "name": "user_delete-event-webhook",
      "description": "**This endpoint allows you to delete a single Event Webhook by ID.** Unlike the [**Get an Event Webhook**](https://docs.sendgrid.com/api-reference/webhooks/get-an-event-webhook) and [**Update an Event Webhook**](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook) endpoints, which will operate on your oldest webhook by `created_date` when you don't provide an ID, this endpoint will return an error if you do not pass it an ID. This behavior prevents customers from unintentionally deleting a webhook. You can retrieve your webhooks' IDs using the [**Get All Event Webhooks**](https://docs.sendgrid.com/api-reference/webhooks/get-all-event-webhooks) endpoint. ### Enable or disable the webhook This endpoint will permanently delete the webhook specified. If you instead want to disable a webhook, you can set the `enabled` property to `false` with the [**Update an Event Webhook**](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook) endpoint. Required: id. Destructive.",
      "method": "DELETE",
      "path": "/v3/user/webhooks/event/settings/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the Event Webhook you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "user_delete-parse-setting",
      "description": "**This endpoint allows you to delete a specific inbound parse setting by hostname.** You can retrieve all your Inbound Parse settings and their associated host names with the 'Retrieve all parse settings' endpoint. Required: hostname. Destructive.",
      "method": "DELETE",
      "path": "/v3/user/webhooks/parse/settings/{hostname}",
      "params": [
        {
          "name": "hostname",
          "type": "string",
          "location": "path",
          "description": "The hostname associated with the inbound parse setting that you would like to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "user_delete-scheduled-send",
      "description": "**This endpoint allows you to delete the cancellation/pause of a scheduled send.** Scheduled sends cancelled less than 10 minutes before the scheduled time are not guaranteed to be cancelled. Required: batch_id. Destructive.",
      "method": "DELETE",
      "path": "/v3/user/scheduled_sends/{batch_id}",
      "params": [
        {
          "name": "batch_id",
          "type": "string",
          "location": "path",
          "description": "Batch id",
          "required": true
        }
      ]
    },
    {
      "name": "user_delete-security-policy",
      "description": "Permanently delete a webhook security policy by its ID. Required: id. Optional: force. Returns the UserDeleteSecurityPolicyResponse. Destructive.",
      "method": "DELETE",
      "path": "/v3/user/webhooks/security/policies/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        },
        {
          "name": "force",
          "type": "bool",
          "location": "query",
          "description": "Force"
        }
      ]
    },
    {
      "name": "user_get-event-webhook",
      "description": "**This endpoint allows you to retrieve a single Event Webhook by ID.** If you do not pass a webhook ID to this endpoint, it will return your oldest webhook by `created_date`. This means the default webhook returned by this endpoint when no ID is provided will be the first one you created. This functionality allows customers who do not have multiple webhooks to use this endpoint to retrieve their only webhook, even if they do not supply an ID. If you have multiple webhooks, you can retrieve their IDs using the [**Get All Event Webhooks**](https://docs.sendgrid.com/api-reference/webhooks/get-all-event-webhooks) endpoint. ### Event settings Your webhook will be returned with all of its settings, which include the events that will be included in the POST request by the webhook and the URL where they will be sent. If an event type is marked as `true`, the event webhook will send information about that event type. See the [**Event Webhook Reference**](https://docs.sendgrid.com/for-developers/tracking-events/event#delivery-events) for details about each event type. ### Signature verification The `public_key` property will be returned only for webhooks with signature verification enabled. ### OAuth You may share one OAuth configuration across all your webhooks or create unique credentials for each. The OAuth properties will be returned only for webhooks with OAuth configured. Required: id. Optional: include. Returns the EventWebhookNoDatesResponse.",
      "method": "GET",
      "path": "/v3/user/webhooks/event/settings/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the Event Webhook you want to retrieve.",
          "required": true
        },
        {
          "name": "include",
          "type": "string",
          "location": "query",
          "description": "Use this to include optional fields in the response payload."
        }
      ]
    },
    {
      "name": "user_get-parse-setting",
      "description": "**This endpoint allows you to retrieve a specific inbound parse setting by hostname.** You can retrieve all your Inbound Parse settings and their associated host names with the 'Retrieve all parse settings' endpoint. Required: hostname. Returns the ParseSetting.",
      "method": "GET",
      "path": "/v3/user/webhooks/parse/settings/{hostname}",
      "params": [
        {
          "name": "hostname",
          "type": "string",
          "location": "path",
          "description": "The hostname associated with the inbound parse setting that you would like to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "user_get-scheduled-send",
      "description": "**This endpoint allows you to retrieve the cancel/paused scheduled send information for a specific `batch_id`.**. Required: batch_id. Returns array of ScheduledSendStatus.",
      "method": "GET",
      "path": "/v3/user/scheduled_sends/{batch_id}",
      "params": [
        {
          "name": "batch_id",
          "type": "string",
          "location": "path",
          "description": "Batch id",
          "required": true
        }
      ]
    },
    {
      "name": "user_get-security-policy",
      "description": "Retrieve the details of a specific webhook security policy by its ID. Required: id. Returns the UserGetSecurityPolicyResponse.",
      "method": "GET",
      "path": "/v3/user/webhooks/security/policies/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        }
      ]
    },
    {
      "name": "user_get-signed-event-webhook",
      "description": "**This endpoint allows you to retrieve the public key for a single Event Webhook by ID.** If you do not pass a webhook ID to this endpoint, it will return the public key for your oldest webhook by `created_date`. This means the default key returned by this endpoint when no ID is provided will be for the first webhook you created. This functionality allows customers who do not have multiple webhooks to use this endpoint to retrieve their only webhook's public key, even if they do not supply an ID. If you have multiple webhooks, you can retrieve their IDs using the [**Get All Event Webhooks**](https://docs.sendgrid.com/api-reference/webhooks/get-all-event-webhooks) endpoint. Once you have enabled signature verification for a webhook, you will need the public key provided to verify the signatures on requests coming from Twilio SendGrid. You can use the webhook ID to [enable or disable signature verification with the endpoint dedicated for that operation](https://docs.sendgrid.com/api-reference/webhooks/toggle-signature-verification-for-an-event-webhook). For more information about cryptographically signing the Event Webhook, see [**Getting Started with the Event Webhook Security Features**](https://sendgrid.com/docs/for-developers/tracking-events/getting-started-event-webhook-security-features). Required: id. Returns the UserGetSignedEventWebhookResponse.",
      "method": "GET",
      "path": "/v3/user/webhooks/event/settings/signed/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the Event Webhook you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "user_list-account",
      "description": "**This endpoint allows you to retrieve your user account details.** Your user's account information includes the user's account type and reputation. Returns the GetUserAccountResponse.",
      "method": "GET",
      "path": "/v3/user/account",
      "params": []
    },
    {
      "name": "user_list-all-security-policies",
      "description": "Returns a list of all webhook security policies configured for your account, including their IDs, names, and security configurations.",
      "method": "GET",
      "path": "/v3/user/webhooks/security/policies",
      "params": []
    },
    {
      "name": "user_list-credit",
      "description": "**This endpoint allows you to retrieve the current credit balance for your account.** Each account has a credit balance, which is a base number of emails it can send before receiving per-email charges. For more information about credits and billing, see [Billing and Plan details information](https://sendgrid.com/docs/ui/account-and-settings/billing/). Returns the UserListCreditResponse.",
      "method": "GET",
      "path": "/v3/user/credits",
      "params": []
    },
    {
      "name": "user_list-email",
      "description": "**This endpoint allows you to retrieve the email address currently on file for your account.**. Returns the UserListEmailResponse.",
      "method": "GET",
      "path": "/v3/user/email",
      "params": []
    },
    {
      "name": "user_list-enforced-tls-setting",
      "description": "**This endpoint allows you to retrieve your current Enforced TLS settings.** The Enforced TLS settings specify whether or not the recipient is required to support TLS or have a valid certificate. If either `require_tls` or `require_valid_cert` is set to `true`, the recipient must support TLS 1.1 or higher or have a valid certificate. If these conditions are not met, Twilio SendGrid will drop the message and send a block event with “TLS required but not supported” as the description. Returns the EnforcedTlsRequestResponse.",
      "method": "GET",
      "path": "/v3/user/settings/enforced_tls",
      "params": []
    },
    {
      "name": "user_list-event-webhook",
      "description": "**This endpoint allows you to retrieve all of your Event Webhooks.** Each webhook will be returned as an object in the `webhooks` array with the webhook's configuration details and ID. You can use a webhook's ID to [update the webhook's settings](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook), [delete the webhook](https://docs.sendgrid.com/api-reference/webhooks/delete-an-event-webhook), [enable or disable signature verification for the webhook](https://docs.sendgrid.com/api-reference/webhooks/toggle-signature-verification-for-an-event-webhook), and, if signature verification is enabled, [retrieve the webhook's public key](https://docs.sendgrid.com/api-reference/webhooks/get-signed-event-webhooks-public-key) when signature verification is enabled. ### Event settings Each webhook's settings determine which events will be included in the POST request by the webhook and the URL where the request will be sent. See the [**Event Webhook Reference**](https://docs.sendgrid.com/for-developers/tracking-events/event#delivery-events) for details about each event type. ### Signature verification The `public_key` property will be returned only for webhooks with signature verification enabled. ### OAuth You may share one OAuth configuration across all your webhooks or create unique credentials for each. The OAuth properties will be returned only for webhooks with OAuth configured. Optional: include. Returns the EventWebhookAllResponse.",
      "method": "GET",
      "path": "/v3/user/webhooks/event/settings/all",
      "params": [
        {
          "name": "include",
          "type": "string",
          "location": "query",
          "description": "Use this to include optional fields in the response payload."
        }
      ]
    },
    {
      "name": "user_list-parse-setting",
      "description": "**This endpoint allows you to retrieve all of your current inbound parse settings.**. Returns the UserListParseSettingResponse.",
      "method": "GET",
      "path": "/v3/user/webhooks/parse/settings",
      "params": []
    },
    {
      "name": "user_list-parse-static",
      "description": "**This endpoint allows you to retrieve the statistics for your Parse Webhook usage.** SendGrid's Inbound Parse Webhook allows you to parse the contents and attachments of incoming emails. The Parse API can then POST the parsed emails to a URL that you specify. The Inbound Parse Webhook cannot parse messages greater than 30MB in size, including all attachments. There are a number of pre-made integrations for the SendGrid Parse Webhook which make processing events easy. You can find these integrations in the [Library Index](https://docs.sendgrid.com/for-developers/sending-email/libraries#webhook-libraries). Required: start_date. Optional: limit, offset, aggregated_by (plus 1 more). Returns array of UserListParseStaticItem.",
      "method": "GET",
      "path": "/v3/user/webhooks/parse/stats",
      "params": [
        {
          "name": "limit",
          "type": "string",
          "location": "query",
          "description": "The number of statistics to return on each page."
        },
        {
          "name": "offset",
          "type": "string",
          "location": "query",
          "description": "The number of statistics to skip."
        },
        {
          "name": "aggregated_by",
          "type": "string",
          "location": "query",
          "description": "How you would like the statistics to by grouped."
        },
        {
          "name": "start_date",
          "type": "string",
          "location": "query",
          "description": "The starting date of the statistics you want to retrieve. Must be in the format YYYY-MM-DD",
          "required": true
        },
        {
          "name": "end_date",
          "type": "string",
          "location": "query",
          "description": "The end date of the statistics you want to retrieve. Must be in the format YYYY-MM-DD"
        }
      ]
    },
    {
      "name": "user_list-profile",
      "description": "**This endpoint allows you to retrieve your current profile details.**. Returns the GetUserProfileResponse.",
      "method": "GET",
      "path": "/v3/user/profile",
      "params": []
    },
    {
      "name": "user_list-scheduled-send",
      "description": "**This endpoint allows you to retrieve all cancelled and paused scheduled send information.** This endpoint will return only the scheduled sends that are associated with a `batch_id`. If you have scheduled a send using the `/mail/send` endpoint and the `send_at` field but no `batch_id`, the send will be scheduled for delivery; however, it will not be returned by this endpoint. For this reason, you should assign a `batch_id` to any scheduled send you may need to pause or cancel in the future. Returns array of ScheduledSendStatus.",
      "method": "GET",
      "path": "/v3/user/scheduled_sends",
      "params": []
    },
    {
      "name": "user_list-username",
      "description": "**This endpoint allows you to retrieve your current account username.**. Returns the UserListUsernameResponse.",
      "method": "GET",
      "path": "/v3/user/username",
      "params": []
    },
    {
      "name": "user_test-event-webhook",
      "description": "**This endpoint allows you to test an Event Webhook.** Retry logic for this endpoint differs from other endpoints, which use a rolling 24-hour retry. This endpoint will make a POST request with a fake event notification to a URL you provide. This allows you to verify that you have properly configured the webhook before sending real data to your URL. ### Test OAuth configuration To test your OAuth configuration, you must include the necessary OAuth properties: `oauth_client_id`, `oauth_client_secret`, and `oauth_token_url`. If the webhook you are testing already has OAuth credentials saved, you will provide only the `oauth_client_id` and `oauth_token_url`—we will pull the secret for you. If you are testing a new set of OAuth credentials that have not been saved with SendGrid, you must provide all three property values. You can retrieve a previously saved `oauth_client_id` and `oauth_token_url` from the [**Get an Event Webhook**](https://docs.sendgrid.com/api-reference/webhooks/get-an-event-webhook) endpoint; however, for security reasons, SendGrid will not provide your `oauth_client_secret`. Required: url. Optional: id, oauth_client_id, oauth_client_secret (plus 1 more).",
      "method": "POST",
      "path": "/v3/user/webhooks/event/test",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "body",
          "description": "The ID of the Event Webhook you want to retrieve."
        },
        {
          "name": "oauth_client_id",
          "type": "string",
          "location": "body",
          "description": "The client ID Twilio SendGrid sends to your OAuth server or service provider to generate an OAuth access token. When passing data in this property, you must also include the `oauth_token_url` property."
        },
        {
          "name": "oauth_client_secret",
          "type": "string",
          "location": "body",
          "description": "The `oauth_client_secret` is needed only once to create an access token. SendGrid will store this secret, allowing you to update your Client ID and Token URL without passing the secret to SendGrid again. When passing data in this field, you must also include the `oauth_client_id` and `oauth_token_url` properties."
        },
        {
          "name": "oauth_token_url",
          "type": "string",
          "location": "body",
          "description": "The URL where Twilio SendGrid sends the Client ID and Client Secret to generate an access token. This should be your OAuth server or service provider. When passing data in this field, you must also include the `oauth_client_id` property."
        },
        {
          "name": "url",
          "type": "string",
          "location": "body",
          "description": "The URL where you would like the test notification to be sent.",
          "required": true
        }
      ]
    },
    {
      "name": "user_update-email",
      "description": "**This endpoint allows you to update the email address currently on file for your account.**. Optional: email. Returns the updated UserUpdateEmailResponse.",
      "method": "PUT",
      "path": "/v3/user/email",
      "params": [
        {
          "name": "email",
          "type": "string",
          "location": "body",
          "description": "The new email address that you would like to use for your account."
        }
      ]
    },
    {
      "name": "user_update-enforced-tls-setting",
      "description": "**This endpoint allows you to update your Enforced TLS settings.** To require TLS from recipients, set `require_tls` to `true`. If either `require_tls` or `require_valid_cert` is set to `true`, the recipient must support TLS 1.1 or higher or have a valid certificate. If these conditions are not met, Twilio SendGrid will drop the message and send a block event with “TLS required but not supported” as the description. Optional: require_tls, require_valid_cert, version (default: 1.1). Returns the updated EnforcedTlsRequestResponse.",
      "method": "PATCH",
      "path": "/v3/user/settings/enforced_tls",
      "params": [
        {
          "name": "require_tls",
          "type": "bool",
          "location": "body",
          "description": "Indicates if you want to require your recipients to support TLS."
        },
        {
          "name": "require_valid_cert",
          "type": "bool",
          "location": "body",
          "description": "Indicates if you want to require your recipients to have a valid certificate."
        },
        {
          "name": "version",
          "type": "float",
          "location": "body",
          "description": "The minimum required TLS certificate version."
        }
      ]
    },
    {
      "name": "user_update-event-webhook",
      "description": "**This endpoint allows you to update a single Event Webhook by ID.** If you do not pass a webhook ID to this endpoint, it will update and return your oldest webhook by `created_date`. This means the default webhook updated by this endpoint when no ID is provided will be the first one you created. This functionality allows customers who do not have multiple webhooks to use this endpoint to update their only webhook, even if they do not supply an ID. If you have multiple webhooks, you can retrieve their IDs using the [**Get All Event Webhooks**](https://docs.sendgrid.com/api-reference/webhooks/get-all-event-webhooks) endpoint. ### Enable or disable the webhook You can set the `enabled` property to `true` to enable the webhook or `false` to disable it. Disabling a webhook will not delete it from your account, but it will prevent the webhook from sending events to your designated URL. ### URL A webhook's URL is the endpoint where you want the webhook to send POST requests containing event data. No more than one webhook may be configured to send to the same URL. SendGrid will return an error if you attempt to set a URL for a webhook that is already in use by the user on another webhook. ### Event settings If an event type is marked as `true`, the event webhook will send information about that event type. See the [**Event Webhook Reference**](https://docs.sendgrid.com/for-developers/tracking-events/event#delivery-events) for details about each event type. ### Webhook identifiers You may assign an optional friendly name to each of your webhooks. The friendly name is for convenience only and should not be used to programmatically differentiate your webhooks because it does not need to be unique. ### OAuth You can configure OAuth for your webhook by passing the required values to this endpoint in the `oauth_client_id`, `oauth_client_secret`, and `oauth_token_url` properties. To disable OAuth, pass an empty string to this endpoint for each of the OAuth properties. You may share one OAuth configuration across all your webhooks or create unique credentials for each. See our [webhook security documentation](https://docs.sendgrid.com/for-developers/tracking-events/getting-started-event-webhook-security-features#oauth-20) for more detailed information about OAuth and the Event Webhook. ### Signature verification Enabling signature verification for your webhook is a separate process and cannot be done with this endpoint. You can use the webhook ID to [enable or disable signature verification with the endpoint dedicated for that operation](https://docs.sendgrid.com/api-reference/webhooks/toggle-signature-verification-for-an-event-webhook). Required: id, url. Optional: include, bounce, click (plus 14 more). Returns the updated EventWebhookUnsignedResponse.",
      "method": "PATCH",
      "path": "/v3/user/webhooks/event/settings/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the Event Webhook you want to retrieve.",
          "required": true
        },
        {
          "name": "include",
          "type": "string",
          "location": "query",
          "description": "Use this to include optional fields in the response payload."
        },
        {
          "name": "bounce",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive bounce events. A bounce occurs when a receiving server could not or would not accept a message."
        },
        {
          "name": "click",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive click events. Click events occur when a recipient clicks on a link within the message. You must [enable Click Tracking](https://docs.sendgrid.com/ui/account-and-settings/tracking#click-tracking) to receive this type of event."
        },
        {
          "name": "deferred",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive deferred events. Deferred events occur when a recipient's email server temporarily rejects a message."
        },
        {
          "name": "delivered",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive delivered events. Delivered events occur when a message has been successfully delivered to the receiving server."
        },
        {
          "name": "dropped",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive dropped events. Dropped events occur when your message is not delivered by Twilio SendGrid. Dropped events are accomponied by a `reason` property, which indicates why the message was dropped. Reasons for a dropped message include: Invalid SMTPAPI header, Spam Content (if spam checker app enabled), Unsubscribed Address, Bounced Address, Spam Reporting Address, Invalid, Recipient List over Package Quota."
        },
        {
          "name": "enabled",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to enable the Event Webhook or `false` to disable it."
        },
        {
          "name": "friendly_name",
          "type": "string",
          "location": "body",
          "description": "Optionally set this property to a friendly name for the Event Webhook. A friendly name may be assigned to each of your webhooks to help you differentiate them. The friendly name is for convenience only. You should use the webhook `id` property for any programmatic tasks."
        },
        {
          "name": "group_resubscribe",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive group resubscribe events. Group resubscribes occur when recipients resubscribe to a specific [unsubscribe group](https://docs.sendgrid.com/ui/sending-email/create-and-manage-unsubscribe-groups) by updating their subscription preferences. You must [enable Subscription Tracking](https://docs.sendgrid.com/ui/account-and-settings/tracking#subscription-tracking) to receive this type of event."
        },
        {
          "name": "group_unsubscribe",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive group unsubscribe events. Group unsubscribes occur when recipients unsubscribe from a specific [unsubscribe group](https://docs.sendgrid.com/ui/sending-email/create-and-manage-unsubscribe-groups) either by direct link or by updating their subscription preferences. You must [enable Subscription Tracking](https://docs.sendgrid.com/ui/account-and-settings/tracking#subscription-tracking) to receive this type of event."
        },
        {
          "name": "oauth_client_id",
          "type": "string",
          "location": "body",
          "description": "Set this property to the OAuth client ID that SendGrid will pass to your OAuth server or service provider to generate an OAuth access token. When passing data in this property, you must also include the `oauth_token_url` property."
        },
        {
          "name": "oauth_client_secret",
          "type": "string",
          "location": "body",
          "description": "Set this property to the OAuth client secret that SendGrid will pass to your OAuth server or service provider to generate an OAuth access token. This secret is needed only once to create an access token. SendGrid will store the secret, allowing you to update your client ID and Token URL without passing the secret to SendGrid again. When passing data in this field, you must also include the `oauth_client_id` and `oauth_token_url` properties."
        },
        {
          "name": "oauth_token_url",
          "type": "string",
          "location": "body",
          "description": "Set this property to the URL where SendGrid will send the OAuth client ID and client secret to generate an OAuth access token. This should be your OAuth server or service provider. When passing data in this field, you must also include the `oauth_client_id` property."
        },
        {
          "name": "open",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive open events. Open events occur when a recipient has opened the HTML message. You must [enable Open Tracking](https://docs.sendgrid.com/ui/account-and-settings/tracking#open-tracking) to receive this type of event."
        },
        {
          "name": "processed",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive processed events. Processed events occur when a message has been received by Twilio SendGrid and the message is ready to be delivered."
        },
        {
          "name": "spam_report",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive spam report events. Spam reports occur when recipients mark a message as spam."
        },
        {
          "name": "unsubscribe",
          "type": "bool",
          "location": "body",
          "description": "Set this property to `true` to receive unsubscribe events. Unsubscribes occur when recipients click on a message's subscription management link. You must [enable Subscription Tracking](https://docs.sendgrid.com/ui/account-and-settings/tracking#subscription-tracking) to receive this type of event."
        },
        {
          "name": "url",
          "type": "string",
          "location": "body",
          "description": "Set this property to the URL where you want the Event Webhook to send event data.",
          "required": true
        }
      ]
    },
    {
      "name": "user_update-parse-setting",
      "description": "**This endpoint allows you to update a specific inbound parse setting by hostname.** You can retrieve all your Inbound Parse settings and their associated host names with the 'Retrieve all parse settings' endpoint. Required: hostname. Optional: send_raw, spam_check, url. Returns the updated ParseSetting.",
      "method": "PATCH",
      "path": "/v3/user/webhooks/parse/settings/{hostname}",
      "params": [
        {
          "name": "hostname",
          "type": "string",
          "location": "path",
          "description": "The hostname associated with the inbound parse setting that you would like to retrieve.",
          "required": true
        },
        {
          "name": "send_raw",
          "type": "bool",
          "location": "body",
          "description": "Indicates if you would like SendGrid to post the original MIME-type content of your parsed email. When this parameter is set to `true`, SendGrid will send a JSON payload of the content of your email."
        },
        {
          "name": "spam_check",
          "type": "bool",
          "location": "body",
          "description": "Indicates if you would like SendGrid to check the content parsed from your emails for spam before POSTing them to your domain."
        },
        {
          "name": "url",
          "type": "string",
          "location": "body",
          "description": "The public URL where you would like SendGrid to POST the data parsed from your email. Any emails sent with the given hostname provided (whose MX records have been updated to point to SendGrid) will be parsed and POSTed to this URL."
        }
      ]
    },
    {
      "name": "user_update-password",
      "description": "**This endpoint allows you to update your password.**. Required: new_password, old_password. Returns the updated UserUpdatePasswordResponse.",
      "method": "PUT",
      "path": "/v3/user/password",
      "params": [
        {
          "name": "new_password",
          "type": "string",
          "location": "body",
          "description": "The new password you would like to use for your account.",
          "required": true
        },
        {
          "name": "old_password",
          "type": "string",
          "location": "body",
          "description": "The old password for your account.",
          "required": true
        }
      ]
    },
    {
      "name": "user_update-profile",
      "description": "**This endpoint allows you to update your current profile details.** Any one or more of the parameters can be updated via the PATCH `/user/profile` endpoint. You must include at least one when you PATCH. Optional: address, address2, city (plus 8 more). Returns the updated UserProfile.",
      "method": "PATCH",
      "path": "/v3/user/profile",
      "params": [
        {
          "name": "address",
          "type": "string",
          "location": "body",
          "description": "The street address for this user profile."
        },
        {
          "name": "address2",
          "type": "string",
          "location": "body",
          "description": "An optional second line for the street address of this user profile."
        },
        {
          "name": "city",
          "type": "string",
          "location": "body",
          "description": "The city for the user profile."
        },
        {
          "name": "company",
          "type": "string",
          "location": "body",
          "description": "That company that this user profile is associated with."
        },
        {
          "name": "country",
          "type": "string",
          "location": "body",
          "description": "Th country of this user profile."
        },
        {
          "name": "first_name",
          "type": "string",
          "location": "body",
          "description": "The first name of the user."
        },
        {
          "name": "last_name",
          "type": "string",
          "location": "body",
          "description": "The last name of the user."
        },
        {
          "name": "phone",
          "type": "string",
          "location": "body",
          "description": "The phone number for the user."
        },
        {
          "name": "state",
          "type": "string",
          "location": "body",
          "description": "The state for this user."
        },
        {
          "name": "website",
          "type": "string",
          "location": "body",
          "description": "The website associated with this user."
        },
        {
          "name": "zip",
          "type": "string",
          "location": "body",
          "description": "The zip code for this user."
        }
      ]
    },
    {
      "name": "user_update-scheduled-send",
      "description": "**This endpoint allows you to update the status of a scheduled send for the given `batch_id`.** If you have already set a `cancel` or `pause` status on a scheduled send using the 'Cancel or pause a scheduled send' endpoint, you can update it's status using this endpoint. Attempting to update a status once it has been set with the 'Cancel or pause a scheduled send' endpoint will result in a `400` error. Required: batch_id, status. Partial update.",
      "method": "PATCH",
      "path": "/v3/user/scheduled_sends/{batch_id}",
      "params": [
        {
          "name": "batch_id",
          "type": "string",
          "location": "path",
          "description": "Batch id",
          "required": true
        },
        {
          "name": "status",
          "type": "string",
          "location": "body",
          "description": "The status you would like the scheduled send to have.",
          "required": true
        }
      ]
    },
    {
      "name": "user_update-security-policy",
      "description": "Update an existing webhook security policy with new configuration values. Required: id. Optional: name, oauth, signature. Returns the updated UserUpdateSecurityPolicyResponse.",
      "method": "PATCH",
      "path": "/v3/user/webhooks/security/policies/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        },
        {
          "name": "name",
          "type": "string",
          "location": "body",
          "description": "User-defined policy name"
        },
        {
          "name": "oauth",
          "type": "object",
          "location": "body",
          "description": "Oauth"
        },
        {
          "name": "signature",
          "type": "object",
          "location": "body",
          "description": "Signature"
        }
      ]
    },
    {
      "name": "user_update-signed-event-webhook",
      "description": "**This endpoint allows you to enable or disable signature verification for a single Event Webhook by ID.** If you do not pass a webhook ID to this endpoint, it will enable signature verification for your oldest webhook by `created_date`. This means the default webhook operated on by this endpoint when no ID is provided will be the first one you created. This functionality allows customers who do not have multiple webhooks to enable or disable signature verifiction for their only webhook, even if they do not supply an ID. If you have multiple webhooks, you can retrieve their IDs using the [**Get All Event Webhooks**](https://docs.sendgrid.com/api-reference/webhooks/get-all-event-webhooks) endpoint. This endpoint accepts a single boolean request property, `enabled`, that can be set `true` or `false` to enable or disable signature verification. This endpoint will return the public key required to verify Twilio SendGrid signatures if it is enabled or an empty string if signing is disabled. You can also retrieve your public key using the [**Get an Event Webhook's Public Key**](https://docs.sendgrid.com/api-reference/webhooks/get-signed-event-webhooks-public-key) endpoint. For more information about cryptographically signing the Event Webhook, see [**Getting Started with the Event Webhook Security Features**](https://sendgrid.com/docs/for-developers/tracking-events/getting-started-event-webhook-security-features). Required: id, enabled. Returns the updated UserUpdateSignedEventWebhookResponse.",
      "method": "PATCH",
      "path": "/v3/user/webhooks/event/settings/signed/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the Event Webhook you want to retrieve.",
          "required": true
        },
        {
          "name": "enabled",
          "type": "bool",
          "location": "body",
          "description": "Enable or disable the webhook by setting this property to `true` or `false`, respectively.",
          "required": true
        }
      ]
    },
    {
      "name": "user_update-username",
      "description": "**This endpoint allows you to update the username for your account.**. Optional: username. Returns the updated UserUpdateUsernameResponse.",
      "method": "PUT",
      "path": "/v3/user/username",
      "params": [
        {
          "name": "username",
          "type": "string",
          "location": "body",
          "description": "The new username you would like to use for your account."
        }
      ]
    },
    {
      "name": "validations_get-email-job-for-verification",
      "description": "**This endpoint returns a specific Bulk Email Validation Job. You can use this endpoint to check on the progress of a Job.**. Required: job_id.",
      "method": "GET",
      "path": "/v3/validations/email/jobs/{job_id}",
      "params": [
        {
          "name": "job_id",
          "type": "string",
          "location": "path",
          "description": "The ID of the Bulk Email Address Validation Job you wish to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "validations_get-email-jobs",
      "description": "**This endpoint returns a list of all of a user's Bulk Email Validation Jobs.**.",
      "method": "GET",
      "path": "/v3/validations/email/jobs",
      "params": []
    },
    {
      "name": "validations_list-email-job-for-verification",
      "description": "**This endpoint returns a presigned URL and request headers. Use this information to upload a list of email addresses for verification.** Note that in a successful response the `content-type` header value matches the provided `file_type` parameter in the `PUT` request. Once you have an `upload_uri` and the `upload_headers`, you're ready to upload your email address list for verification. For the expected format of the email address list and a sample upload request, see the [Bulk Email Address Validation Overview page](https://www.twilio.com/docs/sendgrid/ui/managing-contacts/email-address-validation/bulk-email-address-validation-overview). Required: file_type.",
      "method": "PUT",
      "path": "/v3/validations/email/jobs",
      "params": [
        {
          "name": "file_type",
          "type": "string",
          "location": "body",
          "description": "The format of the file you wish to upload.",
          "required": true
        }
      ]
    },
    {
      "name": "validations_validate-email",
      "description": "**This endpoint allows you to validate an email address.**. Required: email. Optional: source. Returns the new ValidationsValidateEmailResponse.",
      "method": "POST",
      "path": "/v3/validations/email",
      "params": [
        {
          "name": "email",
          "type": "string",
          "location": "body",
          "description": "The email address that you want to validate.",
          "required": true
        },
        {
          "name": "source",
          "type": "string",
          "location": "body",
          "description": "A one-word classifier for where this validation originated."
        }
      ]
    },
    {
      "name": "verified-senders_create",
      "description": "**This endpoint allows you to create a new Sender Identify**. Upon successful submission of a `POST` request to this endpoint, an identity will be created, and a verification email will be sent to the address assigned to the `from_email` field. You must complete the verification process using the sent email to fully verify the sender. If you need to resend the verification email, you can do so with the Resend Verified Sender Request, `/resend/{id}`, endpoint. If you need to authenticate a domain rather than a Single Sender, see the [Domain Authentication API](https://docs.sendgrid.com/api-reference/domain-authentication/authenticate-a-domain). Required: from_email, nickname, reply_to. Optional: address, address2, city (plus 5 more). Returns the new VerifiedSenderResponse.",
      "method": "POST",
      "path": "/v3/verified_senders",
      "params": [
        {
          "name": "address",
          "type": "string",
          "location": "body",
          "description": "Address"
        },
        {
          "name": "address2",
          "type": "string",
          "location": "body",
          "description": "Address2"
        },
        {
          "name": "city",
          "type": "string",
          "location": "body",
          "description": "City"
        },
        {
          "name": "country",
          "type": "string",
          "location": "body",
          "description": "Country"
        },
        {
          "name": "from_email",
          "type": "string",
          "location": "body",
          "description": "From email",
          "required": true
        },
        {
          "name": "from_name",
          "type": "string",
          "location": "body",
          "description": "From name"
        },
        {
          "name": "nickname",
          "type": "string",
          "location": "body",
          "description": "Nickname",
          "required": true
        },
        {
          "name": "reply_to",
          "type": "string",
          "location": "body",
          "description": "Reply to",
          "required": true
        },
        {
          "name": "reply_to_name",
          "type": "string",
          "location": "body",
          "description": "Reply to name"
        },
        {
          "name": "state",
          "type": "string",
          "location": "body",
          "description": "State"
        },
        {
          "name": "zip",
          "type": "string",
          "location": "body",
          "description": "Zip"
        }
      ]
    },
    {
      "name": "verified-senders_delete",
      "description": "**This endpoint allows you to delete a Sender Identity**. Pass the `id` assigned to a Sender Identity to this endpoint to delete the Sender Identity from your account. You can retrieve the IDs associated with Sender Identities using the 'Get All Verified Senders' endpoint. Required: id. Destructive.",
      "method": "DELETE",
      "path": "/v3/verified_senders/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        }
      ]
    },
    {
      "name": "verified-senders_list",
      "description": "**This endpoint allows you to retrieve all the Sender Identities associated with an account.** This endpoint will return both verified and unverified senders. You can limit the number of results returned using the `limit`, `lastSeenID`, and `id` query string parameters. * `limit` allows you to specify an exact number of Sender Identities to return. * `lastSeenID` will return senders with an ID number occuring after the passed in ID. In other words, the `lastSeenID` provides a starting point from which SendGrid will iterate to find Sender Identities associated with your account. * `id` will return information about only the Sender Identity passed in the request. Optional: limit, lastSeenID, id. Returns the VerifiedSendersListResponse.",
      "method": "GET",
      "path": "/v3/verified_senders",
      "params": [
        {
          "name": "limit",
          "type": "float",
          "location": "query",
          "description": "Specifies the number of results to be returned by the API. This parameter can be used to limit the results returned or in combination with the `lastSeenID` parameter to iterate through paginated results."
        },
        {
          "name": "lastSeenID",
          "type": "float",
          "location": "query",
          "description": "Returns senders with an ID number occurring after the passed in ID. In other words, the `lastSeenID` provides a starting point from which SendGrid will iterate to find Sender Identities associated with your account."
        },
        {
          "name": "id",
          "type": "int",
          "location": "query",
          "description": "Returns information about only the Sender Identity passed in the request."
        }
      ]
    },
    {
      "name": "verified-senders_list-domain",
      "description": "**This endpoint returns a list of domains known to implement DMARC and categorizes them by failure type — hard failure or soft failure**. Domains listed as hard failures will not deliver mail when used as a [Sender Identity](https://sendgrid.com/docs/for-developers/sending-email/sender-identity/) due to the domain's DMARC policy settings. For example, using a `yahoo.com` email address as a Sender Identity will likely result in the rejection of your mail. For more information about DMARC, see [Everything about DMARC](https://sendgrid.com/docs/ui/sending-email/dmarc/).",
      "method": "GET",
      "path": "/v3/verified_senders/domains",
      "params": []
    },
    {
      "name": "verified-senders_list-steps-completed",
      "description": "**This endpoint allows you to determine which of SendGrid’s verification processes have been completed for an account**. This endpoint returns boolean values, `true` and `false`, for [Domain Authentication](https://sendgrid.com/docs/for-developers/sending-email/sender-identity/#domain-authentication), `domain_verified`, and [Single Sender Verification](https://sendgrid.com/docs/for-developers/sending-email/sender-identity/#single-sender-verification), `sender_verified`, for the account. An account may have one, both, or neither verification steps completed. If you need to authenticate a domain rather than a Single Sender, see the 'Authenticate a domain' endpoint.",
      "method": "GET",
      "path": "/v3/verified_senders/steps_completed",
      "params": []
    },
    {
      "name": "verified-senders_resend",
      "description": "**This endpoint allows you to resend a verification email to a specified Sender Identity**. Passing the `id` assigned to a Sender Identity to this endpoint will resend a verification email to the `from_address` associated with the Sender Identity. This can be useful if someone loses their verification email or needs to have it resent for any other reason. You can retrieve the IDs associated with Sender Identities by passing a 'Get All Verified Senders' endpoint. Required: id.",
      "method": "POST",
      "path": "/v3/verified_senders/resend/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        }
      ]
    },
    {
      "name": "verified-senders_update",
      "description": "**This endpoint allows you to update an existing Sender Identity**. Pass the `id` assigned to a Sender Identity to this endpoint as a path parameter. Include any fields you wish to update in the request body in JSON format. You can retrieve the IDs associated with Sender Identities by passing a `GET` request to the Get All Verified Senders endpoint, `/verified_senders`. **Note:** Unlike a `PUT` request, `PATCH` allows you to update only the fields you wish to edit. Fields that are not passed as part of a request will remain unaltered. Required: id, from_email, nickname, reply_to. Optional: address, address2, city (plus 5 more). Returns the updated VerifiedSenderResponse.",
      "method": "PATCH",
      "path": "/v3/verified_senders/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "Id",
          "required": true
        },
        {
          "name": "address",
          "type": "string",
          "location": "body",
          "description": "Address"
        },
        {
          "name": "address2",
          "type": "string",
          "location": "body",
          "description": "Address2"
        },
        {
          "name": "city",
          "type": "string",
          "location": "body",
          "description": "City"
        },
        {
          "name": "country",
          "type": "string",
          "location": "body",
          "description": "Country"
        },
        {
          "name": "from_email",
          "type": "string",
          "location": "body",
          "description": "From email",
          "required": true
        },
        {
          "name": "from_name",
          "type": "string",
          "location": "body",
          "description": "From name"
        },
        {
          "name": "nickname",
          "type": "string",
          "location": "body",
          "description": "Nickname",
          "required": true
        },
        {
          "name": "reply_to",
          "type": "string",
          "location": "body",
          "description": "Reply to",
          "required": true
        },
        {
          "name": "reply_to_name",
          "type": "string",
          "location": "body",
          "description": "Reply to name"
        },
        {
          "name": "state",
          "type": "string",
          "location": "body",
          "description": "State"
        },
        {
          "name": "zip",
          "type": "string",
          "location": "body",
          "description": "Zip"
        }
      ]
    },
    {
      "name": "verified-senders_verify-sender-token",
      "description": "**This endpoint allows you to verify a sender requests.** The token is generated by SendGrid and included in a verification email delivered to the address that's pending verification. Required: token.",
      "method": "GET",
      "path": "/v3/verified_senders/verify/{token}",
      "params": [
        {
          "name": "token",
          "type": "string",
          "location": "path",
          "description": "Token",
          "required": true
        }
      ]
    },
    {
      "name": "whitelabel_add-ip-to-authenticated-domain",
      "description": "**This endpoint allows you to add an IP address to an authenticated domain.**. Required: id, ip. Returns the new AuthenticatedDomainSpf.",
      "method": "POST",
      "path": "/v3/whitelabel/domains/{id}/ips",
      "params": [
        {
          "name": "id",
          "type": "int",
          "location": "path",
          "description": "ID of the domain to which you are adding an IP",
          "required": true
        },
        {
          "name": "ip",
          "type": "string",
          "location": "body",
          "description": "IP to associate with the domain. Used for manually specifying IPs for custom SPF.",
          "required": true
        }
      ]
    },
    {
      "name": "whitelabel_associate-branded-link-with-subuser",
      "description": "**This endpoint allows you to associate a branded link with a subuser account.** Link branding can be associated with subusers from the parent account. This functionality allows subusers to send mail using their parent's link branding. To associate link branding, the parent account must first create a branded link and validate it. The parent may then associate that branded link with a subuser via the API or the [Subuser Management page of the Twilio SendGrid App](https://app.sendgrid.com/settings/subusers). Required: link_id. Optional: username. Returns the new LinkBranding200.",
      "method": "POST",
      "path": "/v3/whitelabel/links/{link_id}/subuser",
      "params": [
        {
          "name": "link_id",
          "type": "int",
          "location": "path",
          "description": "The ID of the branded link you want to associate.",
          "required": true
        },
        {
          "name": "username",
          "type": "string",
          "location": "body",
          "description": "The username of the subuser account that you want to associate the branded link with."
        }
      ]
    },
    {
      "name": "whitelabel_associate-subuser-with-domain",
      "description": "**This endpoint allows you to associate a specific authenticated domain with a subuser.** Authenticated domains can be associated with (i.e. assigned to) subusers from a parent account. This functionality allows subusers to send mail using their parent's domain. To associate an authenticated domain with a subuser, the parent account must first authenticate and validate the domain. The parent may then associate the authenticated domain via the subuser management tools. [You can associate more than one domain with a subuser using the `v3/whitelabel/domains/{domain_id}/subuser:add` endpoint](https://www.twilio.com/docs/sendgrid/api-reference/domain-authentication/associate-an-authenticated-domain-with-a-subuser-multiple). Required: domain_id, username. Returns the new AuthenticatedDomainSpf.",
      "method": "POST",
      "path": "/v3/whitelabel/domains/{domain_id}/subuser",
      "params": [
        {
          "name": "domain_id",
          "type": "int",
          "location": "path",
          "description": "ID of the authenticated domain to associate with the subuser.",
          "required": true
        },
        {
          "name": "username",
          "type": "string",
          "location": "body",
          "description": "Username to associate with the authenticated domain.",
          "required": true
        }
      ]
    },
    {
      "name": "whitelabel_associate-subuser-with-domain-multiple",
      "description": "**This endpoint allows you to associate a specific authenticated domain with a subuser. It can be used to associate up to five authenticated domains.** This functionality allows subusers to send mail using their parent's domain. Authenticated domains can be associated with (i.e. assigned to) subusers from a parent account. To associate an authenticated domain with a subuser, the parent account must first authenticate and validate the domain. The parent may then associate the authenticated domain via the subuser management tools. A subuser can have up to five associated authenticated domains. To see the domains that have already been associated with this user, you can [use the API to list the domains currently associated with the subuser](https://www.twilio.com/docs/sendgrid/api-reference/domain-authentication/list-the-authenticated-domain-associated-with-a-subuser-multiple). When selecting a domain to send email from, SendGrid checks for domains in the following order and chooses the first one that appears in the hierarchy: 1. Domain assigned by the subuser that matches the email's `From` address domain. 2. The subuser's default domain. 3. Domain assigned by the parent user that matches the `From` address domain. 4. Parent user's default domain. 5. sendgrid.net. Required: domain_id, username. Returns the new AuthenticatedDomainSpf.",
      "method": "POST",
      "path": "/v3/whitelabel/domains/{domain_id}/subuser:add",
      "params": [
        {
          "name": "domain_id",
          "type": "int",
          "location": "path",
          "description": "ID of the authenticated domain to associate with the subuser.",
          "required": true
        },
        {
          "name": "username",
          "type": "string",
          "location": "body",
          "description": "Username to associate with the authenticated domain.",
          "required": true
        }
      ]
    },
    {
      "name": "whitelabel_authenticate-domain",
      "description": "**This endpoint allows you to authenticate a domain.** If you are authenticating a domain for a subuser, you have two options: 1. Use the 'username' parameter. This allows you to authenticate a domain on behalf of your subuser. This means the subuser is able to see and modify the authenticated domain. 2. Use the Association workflow (see Associate Domain section). This allows you to authenticate a domain created by the parent to a subuser. This means the subuser will default to the assigned domain, but will not be able to see or modify that authenticated domain. However, if the subuser authenticates their own domain it will overwrite the assigned domain. Required: domain. Optional: automatic_security, custom_dkim_selector, custom_spf (plus 5 more). Returns the new AuthenticatedDomain.",
      "method": "POST",
      "path": "/v3/whitelabel/domains",
      "params": [
        {
          "name": "automatic_security",
          "type": "bool",
          "location": "body",
          "description": "Whether to allow SendGrid to manage your SPF records, DKIM keys, and DKIM key rotation."
        },
        {
          "name": "custom_dkim_selector",
          "type": "string",
          "location": "body",
          "description": "Add a custom DKIM selector. Accepts three letters or numbers."
        },
        {
          "name": "custom_spf",
          "type": "bool",
          "location": "body",
          "description": "Specify whether to use a custom SPF or allow SendGrid to manage your SPF. This option is only available to authenticated domains set up for manual security."
        },
        {
          "name": "default",
          "type": "bool",
          "location": "body",
          "description": "Whether to use this authenticated domain as the fallback if no authenticated domains match the sender's domain."
        },
        {
          "name": "domain",
          "type": "string",
          "location": "body",
          "description": "Domain being authenticated.",
          "required": true
        },
        {
          "name": "ips",
          "type": "array",
          "location": "body",
          "description": "The IP addresses that will be included in the custom SPF record for this authenticated domain."
        },
        {
          "name": "region",
          "type": "string",
          "location": "body",
          "description": "The region of the domain. Allowed values are `global` and `eu`. The default value is `global`."
        },
        {
          "name": "subdomain",
          "type": "string",
          "location": "body",
          "description": "The subdomain or custom return-path to use for this authenticated domain."
        },
        {
          "name": "username",
          "type": "string",
          "location": "body",
          "description": "The username associated with this domain."
        }
      ]
    },
    {
      "name": "whitelabel_create-branded-link",
      "description": "**This endpoint allows you to create a new branded link.** To create the link branding, supply the root domain and, optionally, the subdomain — these go into separate fields in your request body. The root domain should match your FROM email address. If you provide a subdomain, it must be different from the subdomain you used for authenticating your domain. You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request. Required: domain. Optional: default, region (default: us), subdomain. Returns the new LinkBranding200.",
      "method": "POST",
      "path": "/v3/whitelabel/links",
      "params": [
        {
          "name": "default",
          "type": "bool",
          "location": "body",
          "description": "Indicates if you want to use this link branding as the default or fallback. When setting a new default, the existing default link branding will have its default status removed automatically."
        },
        {
          "name": "domain",
          "type": "string",
          "location": "body",
          "description": "The root domain for the subdomain that you are creating the link branding for. This should match your FROM email address.",
          "required": true
        },
        {
          "name": "region",
          "type": "string",
          "location": "body",
          "description": "The region of the IP address. Can be `eu` or `us`."
        },
        {
          "name": "subdomain",
          "type": "string",
          "location": "body",
          "description": "The subdomain to create the link branding for. Must be different from the subdomain you used for authenticating your domain."
        }
      ]
    },
    {
      "name": "whitelabel_delete-authenticated-domain",
      "description": "**This endpoint allows you to delete an authenticated domain.**. Required: domain_id. Destructive.",
      "method": "DELETE",
      "path": "/v3/whitelabel/domains/{domain_id}",
      "params": [
        {
          "name": "domain_id",
          "type": "string",
          "location": "path",
          "description": "Domain id",
          "required": true
        }
      ]
    },
    {
      "name": "whitelabel_delete-branded-link",
      "description": "**This endpoint allows you to delete a branded link.** Your request will receive a response with a 204 status code if the deletion was successful. The call does not return the link's details, so if you wish to record these make sure you call the 'Retrieve a branded link' endpoint *before* you request its deletion. You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request. Required: id. Destructive.",
      "method": "DELETE",
      "path": "/v3/whitelabel/links/{id}",
      "params": [
        {
          "name": "id",
          "type": "int",
          "location": "path",
          "description": "The ID of the branded link you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "whitelabel_delete-ip-from-authenticated-domain",
      "description": "**This endpoint allows you to remove an IP address from that domain's authentication.**. Required: id, ip. Returns the AuthenticatedDomainSpf. Destructive.",
      "method": "DELETE",
      "path": "/v3/whitelabel/domains/{id}/ips/{ip}",
      "params": [
        {
          "name": "id",
          "type": "int",
          "location": "path",
          "description": "ID of the domain to delete the IP from.",
          "required": true
        },
        {
          "name": "ip",
          "type": "string",
          "location": "path",
          "description": "IP to remove from the domain.",
          "required": true
        }
      ]
    },
    {
      "name": "whitelabel_delete-reverse-dns",
      "description": "**This endpoint allows you to delete a reverse DNS record.** A call to this endpoint will respond with a 204 status code if the deletion was successful. You can retrieve the IDs associated with all your reverse DNS records using the 'Retrieve all reverse DNS records' endpoint. Required: id. Destructive.",
      "method": "DELETE",
      "path": "/v3/whitelabel/ips/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the reverse DNS record that you would like to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "whitelabel_disassociate-authenticated-domain-from-user",
      "description": "**This endpoint allows you to disassociate a specific authenticated domain from a subuser.** Authenticated domains can be associated with (i.e. assigned to) subusers from a parent account. This functionality allows subusers to send mail using their parent's domain. To associate an authenticated domain with a subuser, the parent account must first authenticate and validate the domain. The parent may then associate the authenticated domain via the subuser management tools. Note that if you used the [`/v3/whitelabel/domains/{domain_id}/subuser:add` endpoint](https://www.twilio.com/docs/sendgrid/api-reference/domain-authentication/associate-an-authenticated-domain-with-a-subuser-multiple) to add multiple domains to the subuser, you should use the [`/v3/whitelabel/domains/{domain_id}/subuser` endpoint](https://www.twilio.com/docs/sendgrid/api-reference/domain-authentication/disassociate-an-authenticated-domain-from-a-subuser-multiple) to disassociate those domains. Optional: username. Destructive.",
      "method": "DELETE",
      "path": "/v3/whitelabel/domains/subuser",
      "params": [
        {
          "name": "username",
          "type": "string",
          "location": "query",
          "description": "Username for the subuser to find associated authenticated domain."
        }
      ]
    },
    {
      "name": "whitelabel_disassociate-branded-link-from-subuser",
      "description": "**This endpoint allows you to take a branded link away from a subuser.** Link branding can be associated with subusers from the parent account. This functionality allows subusers to send mail using their parent's link branding. To associate link branding, the parent account must first create a branded link and validate it. The parent may then associate that branded link with a subuser via the API or the [Subuser Management page of the Twilio SendGrid App](https://app.sendgrid.com/settings/subusers). Your request will receive a response with a 204 status code if the disassociation was successful. Required: username. Destructive.",
      "method": "DELETE",
      "path": "/v3/whitelabel/links/subuser",
      "params": [
        {
          "name": "username",
          "type": "string",
          "location": "query",
          "description": "The username of the subuser account that you want to disassociate a branded link from.",
          "required": true
        }
      ]
    },
    {
      "name": "whitelabel_disassociate-subuser-from-domain",
      "description": "**This endpoint allows you to disassociate a specific authenticated domain from a subuser, for users with up to five associated domains.** This functionality allows subusers to send mail using their parent's domain. Authenticated domains can be associated with (i.e. assigned to) subusers kknt, and a subuser can have up to five associated authenticated domains. You can dissociate an authenticated domain from any subuser that has one or more authenticated domains using this endpoint. Required: domain_id. Optional: username. Destructive.",
      "method": "DELETE",
      "path": "/v3/whitelabel/domains/{domain_id}/subuser",
      "params": [
        {
          "name": "username",
          "type": "string",
          "location": "query",
          "description": "Username for the subuser to find associated authenticated domain."
        },
        {
          "name": "domain_id",
          "type": "int",
          "location": "path",
          "description": "ID of the authenticated domain to be disassociated with the subuser.",
          "required": true
        }
      ]
    },
    {
      "name": "whitelabel_email-dns-record",
      "description": "**This endpoint is used to share DNS records with a colleagues** Use this endpoint to send SendGrid-generated DNS record information to a co-worker so they can enter it into your DNS provider to validate your domain and link branding. What type of records are sent will depend on whether you have chosen Automated Security or not. When using Automated Security, SendGrid provides you with three CNAME records. If you turn Automated Security off, you are instead given TXT and MX records. If you pass a `link_id` to this endpoint, the generated email will supply the DNS records necessary to complete [Link Branding](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-link-branding/) setup. If you pass a `domain_id` to this endpoint, the generated email will supply the DNS records needed to complete [Domain Authentication](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-domain-authentication/). Passing both IDs will generate an email with the records needed to complete both setup steps. You can retrieve all your domain IDs from the returned `id` fields for each domain using the 'List all authenticated domains' endpoint. You can retrieve all of your link IDs using the 'Retrieve all branded links' endpoint. Required: domain_id, email, link_id. Optional: message.",
      "method": "POST",
      "path": "/v3/whitelabel/dns/email",
      "params": [
        {
          "name": "domain_id",
          "type": "int",
          "location": "body",
          "description": "The ID of your SendGrid domain record.",
          "required": true
        },
        {
          "name": "email",
          "type": "string",
          "location": "body",
          "description": "The email address to send the DNS information to.",
          "required": true
        },
        {
          "name": "link_id",
          "type": "int",
          "location": "body",
          "description": "The ID of the branded link.",
          "required": true
        },
        {
          "name": "message",
          "type": "string",
          "location": "body",
          "description": "A custom text block to include in the email body sent with the records."
        }
      ]
    },
    {
      "name": "whitelabel_get-authenticated-domain",
      "description": "**This endpoint allows you to retrieve a specific authenticated domain.**. Required: domain_id. Returns the AuthenticatedDomain.",
      "method": "GET",
      "path": "/v3/whitelabel/domains/{domain_id}",
      "params": [
        {
          "name": "domain_id",
          "type": "string",
          "location": "path",
          "description": "Domain id",
          "required": true
        }
      ]
    },
    {
      "name": "whitelabel_get-branded-link",
      "description": "**This endpoint allows you to retrieve a specific branded link by providing its ID.** You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request. Required: id. Returns the LinkBranding200.",
      "method": "GET",
      "path": "/v3/whitelabel/links/{id}",
      "params": [
        {
          "name": "id",
          "type": "int",
          "location": "path",
          "description": "The ID of the branded link you want to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "whitelabel_get-reverse-dns",
      "description": "**This endpoint allows you to retrieve a reverse DNS record.** You can retrieve the IDs associated with all your reverse DNS records using the 'Retrieve all reverse DNS records' endpoint. Required: id. Returns the ReverseDns.",
      "method": "GET",
      "path": "/v3/whitelabel/ips/{id}",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the reverse DNS record that you would like to retrieve.",
          "required": true
        }
      ]
    },
    {
      "name": "whitelabel_list-all-authenticated-domain-with-user",
      "description": "**This endpoint allows you to retrieve all of the authenticated domains that have been assigned to a specific subuser.** This functionality allows subusers to send mail using their parent's domain. Authenticated domains can be associated with (i.e. assigned to) subusers from a parent account, and a subuser can have up to five associated domains. To associate an authenticated domain with a subuser, the parent account must first authenticate and validate the domain. The parent may then associate the authenticated domain via the subuser management tools. When selecting a domain to send email from, SendGrid checks for domains in the following order and chooses the first one that appears in the hierarchy: 1. Domain assigned by the subuser that matches the email's `From` address domain. 2. The subuser's default domain. 3. Domain assigned by the parent user that matches the `From` address domain. 4. Parent user's default domain. 5. sendgrid.net. Required: username. Returns array of WhitelabelListAllAuthenticatedDomainWithUserItem.",
      "method": "GET",
      "path": "/v3/whitelabel/domains/subuser/all",
      "params": [
        {
          "name": "username",
          "type": "string",
          "location": "query",
          "description": "Username for the subuser to find associated authenticated domains.",
          "required": true
        }
      ]
    },
    {
      "name": "whitelabel_list-authenticated-domain",
      "description": "**This endpoint allows you to retrieve a paginated list of all domains you have authenticated.** You can use the `limit` query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the `offset` query parameter to control the position in the list from which to start retrieving additional items. Optional: limit, offset (default: 0), exclude_subusers (plus 2 more). Returns array of WhitelabelListAuthenticatedDomainItem.",
      "method": "GET",
      "path": "/v3/whitelabel/domains",
      "params": [
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "`limit` sets the page size, i."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The number of items in the list to skip over before starting to retrieve the items for the..."
        },
        {
          "name": "exclude_subusers",
          "type": "bool",
          "location": "query",
          "description": "Exclude subuser domains from the result."
        },
        {
          "name": "username",
          "type": "string",
          "location": "query",
          "description": "The username associated with an authenticated domain."
        },
        {
          "name": "domain",
          "type": "string",
          "location": "query",
          "description": "Search for authenticated domains."
        }
      ]
    },
    {
      "name": "whitelabel_list-authenticated-domain-with-user",
      "description": "**This endpoint allows you to retrieve all of the authenticated domains that have been assigned to a specific subuser.** Authenticated domains can be associated with (i.e. assigned to) subusers from a parent account. This functionality allows subusers to send mail using their parent's domain. To associate an authenticated domain with a subuser, the parent account must first authenticate and validate the domain. The parent may then associate the authenticated domain via the subuser management tools. Note that if you used the [`/v3/whitelabel/domains/{domain_id}/subuser:add` endpoint]( https://www.twilio.com/docs/sendgrid/api-reference/domain-authentication/associate-an-authenticated-domain-with-a-subuser-multiple) to add multiple domains to the subuser, you can use the [`/v3/whitelabel/domains/subuser/all` endpoint](https://www.twilio.com/docs/sendgrid/api-reference/domain-authentication/list-the-authenticated-domain-associated-with-a-subuser-multiple) to list those associated domains. Required: username. Returns the AuthenticatedDomainSpf.",
      "method": "GET",
      "path": "/v3/whitelabel/domains/subuser",
      "params": [
        {
          "name": "username",
          "type": "string",
          "location": "query",
          "description": "Username for the subuser to find associated authenticated domain.",
          "required": true
        }
      ]
    },
    {
      "name": "whitelabel_list-branded-link",
      "description": "**This endpoint allows you to retrieve all branded links**. You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request. Optional: limit. Returns array of LinkBranding200.",
      "method": "GET",
      "path": "/v3/whitelabel/links",
      "params": [
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "Limits the number of results returned per page."
        }
      ]
    },
    {
      "name": "whitelabel_list-default-authenticated-domain",
      "description": "**This endpoint allows you to retrieve the default authentication for a domain.** When creating or updating a domain authentication, you can set the domain as a default. The default domain will be used to send all mail. If you have multiple authenticated domains, the authenticated domain matching the domain of the From address will be used, and the default will be overridden. This endpoint will return a default domain and its details only if a default is set. You are not required to set a default. If you do not set a default domain, this endpoint will return general information about your domain authentication status. Optional: domain. Returns array of WhitelabelListDefaultAuthenticatedDomainItem.",
      "method": "GET",
      "path": "/v3/whitelabel/domains/default",
      "params": [
        {
          "name": "domain",
          "type": "string",
          "location": "query",
          "description": "The domain to find a default authentication."
        }
      ]
    },
    {
      "name": "whitelabel_list-default-branded-link",
      "description": "**This endpoint allows you to retrieve the default branded link.** The default branded link is the actual URL to be used when sending messages. If you have more than one branded link, the default is determined by the following order: * The validated branded link marked as `default` (set when you call the 'Create a branded link' endpoint or by calling the 'Update a branded link' endpoint on an existing link) * Legacy branded links (migrated from the whitelabel wizard) * Default SendGrid-branded links (i.e., `100.ct.sendgrid.net`) You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request. Optional: domain. Returns the LinkBranding200.",
      "method": "GET",
      "path": "/v3/whitelabel/links/default",
      "params": [
        {
          "name": "domain",
          "type": "string",
          "location": "query",
          "description": "The domain to match against when finding the default branded link."
        }
      ]
    },
    {
      "name": "whitelabel_list-reverse-dns",
      "description": "**This endpoint allows you to retrieve a paginated list of all the Reverse DNS records created by this account.** You may include a search key by using the `ip` query string parameter. This enables you to perform a prefix search for a given IP segment (e.g., `?ip='192.'`). You can use the `limit` query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the `offset` query parameter to control the position in the list from which to start retrieving additional items. Optional: limit, offset (default: 0), ip. Returns array of ReverseDns.",
      "method": "GET",
      "path": "/v3/whitelabel/ips",
      "params": [
        {
          "name": "limit",
          "type": "int",
          "location": "query",
          "description": "`limit` sets the page size, i."
        },
        {
          "name": "offset",
          "type": "int",
          "location": "query",
          "description": "The number of items in the list to skip over before starting to retrieve the items for the..."
        },
        {
          "name": "ip",
          "type": "string",
          "location": "query",
          "description": "The IP address segment that you'd like to use in a prefix search."
        }
      ]
    },
    {
      "name": "whitelabel_list-subuser-branded-link",
      "description": "**This endpoint allows you to retrieve the branded link associated with a subuser.** Link branding can be associated with subusers from the parent account. This functionality allows subusers to send mail using their parent's link branding. To associate link branding, the parent account must first create a branded link and then validate it. The parent may then associate that branded link with a subuser via the API or the [Subuser Management page of the Twilio SendGrid App](https://app.sendgrid.com/settings/subusers). Required: username. Returns the LinkBranding200.",
      "method": "GET",
      "path": "/v3/whitelabel/links/subuser",
      "params": [
        {
          "name": "username",
          "type": "string",
          "location": "query",
          "description": "The username of the subuser to retrieve associated branded links for.",
          "required": true
        }
      ]
    },
    {
      "name": "whitelabel_set-up-reverse-dns",
      "description": "**This endpoint allows you to set up reverse DNS.**. Required: domain, ip. Optional: subdomain. Returns the new ReverseDns.",
      "method": "POST",
      "path": "/v3/whitelabel/ips",
      "params": [
        {
          "name": "domain",
          "type": "string",
          "location": "body",
          "description": "The root, or sending, domain that will be used to send message from the IP address.",
          "required": true
        },
        {
          "name": "ip",
          "type": "string",
          "location": "body",
          "description": "The IP address for which you want to set up reverse DNS.",
          "required": true
        },
        {
          "name": "subdomain",
          "type": "string",
          "location": "body",
          "description": "The subdomain that will be used to send emails from the IP address. This should be the same as the subdomain used to set up an authenticated domain."
        }
      ]
    },
    {
      "name": "whitelabel_update-authenticated-domain",
      "description": "**This endpoint allows you to update the settings for an authenticated domain.**. Required: domain_id. Optional: custom_spf (default: false), default (default: false). Returns array of WhitelabelUpdateAuthenticatedDomainItem.",
      "method": "PATCH",
      "path": "/v3/whitelabel/domains/{domain_id}",
      "params": [
        {
          "name": "domain_id",
          "type": "string",
          "location": "path",
          "description": "Domain id",
          "required": true
        },
        {
          "name": "custom_spf",
          "type": "bool",
          "location": "body",
          "description": "Indicates whether to generate a custom SPF record for manual security."
        },
        {
          "name": "default",
          "type": "bool",
          "location": "body",
          "description": "Indicates whether this is the default authenticated domain."
        }
      ]
    },
    {
      "name": "whitelabel_update-branded-link",
      "description": "**This endpoint allows you to update a specific branded link. You can use this endpoint to change a branded link's default status.** You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request. Required: id. Optional: default. Returns the updated LinkBranding200.",
      "method": "PATCH",
      "path": "/v3/whitelabel/links/{id}",
      "params": [
        {
          "name": "id",
          "type": "int",
          "location": "path",
          "description": "The ID of the branded link you want to retrieve.",
          "required": true
        },
        {
          "name": "default",
          "type": "bool",
          "location": "body",
          "description": "Indicates if the branded link is set as the default. When setting a new default, the existing default link branding will have its default status removed automatically."
        }
      ]
    },
    {
      "name": "whitelabel_validate-authenticated-domain",
      "description": "**This endpoint allows you to validate an authenticated domain. If it fails, it will return an error message describing why the domain could not be validated.**. Required: id. Returns the new WhitelabelValidateAuthenticatedDomainResponse.",
      "method": "POST",
      "path": "/v3/whitelabel/domains/{id}/validate",
      "params": [
        {
          "name": "id",
          "type": "int",
          "location": "path",
          "description": "ID of the domain to validate.",
          "required": true
        }
      ]
    },
    {
      "name": "whitelabel_validate-branded-link",
      "description": "**This endpoint allows you to validate a branded link.** You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request. Required: id. Returns the new WhitelabelValidateBrandedLinkResponse.",
      "method": "POST",
      "path": "/v3/whitelabel/links/{id}/validate",
      "params": [
        {
          "name": "id",
          "type": "int",
          "location": "path",
          "description": "The ID of the branded link that you want to validate.",
          "required": true
        }
      ]
    },
    {
      "name": "whitelabel_validate-reverse-dns",
      "description": "**This endpoint allows you to validate a reverse DNS record.** Always check the `valid` property of the response’s `validation_results.a_record` object. This field will indicate whether it was possible to validate the reverse DNS record. If the `validation_results.a_record.valid` is `false`, this indicates only that Twilio SendGrid could not determine the validity your reverse DNS record — it may still be valid. If validity couldn’t be determined, you can check the value of `validation_results.a_record.reason` to find out why. You can retrieve the IDs associated with all your reverse DNS records using the 'Retrieve all reverse DNS records' endpoint. Required: id. Returns the new WhitelabelValidateReverseDnsResponse.",
      "method": "POST",
      "path": "/v3/whitelabel/ips/{id}/validate",
      "params": [
        {
          "name": "id",
          "type": "string",
          "location": "path",
          "description": "The ID of the reverse DNS record that you would like to validate.",
          "required": true
        }
      ]
    }
  ]
}