SendGrid

Parámetros de entrada

• version_idstringObligatorio

  The ID of the template version

• template_idstringObligatorio

  The ID of the original template

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• ipsstring[]Obligatorio

  An array of IP addresses to assign to the specified IP Pool. All assignments must succeed.

• poolidstringObligatorio

  Specifies the unique ID for an IP Pool.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• ipstring

  The IP address that you want to add to the named pool.

• pool_namestringObligatorio

  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").

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idintegerObligatorio

  ID of the domain to which you are adding an IP

• ipstringObligatorio

  IP to associate with the domain. Used for manually specifying IPs for custom SPF.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• list_idintegerObligatorio

  The ID of the list that you want to add the recipient to.

• recipient_idstringObligatorio

  The ID of the recipient you are adding to the list.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• regionstringenum

  Region

  globaleu
• subusersstring[]

  An array of Subuser IDs the IP address will be assigned to.

• include_regionboolean

  Boolean indicating whether or not to return the IP address"s region information in the response.

• is_auto_warmupbooleanObligatorio

  Indicates if the IP address is set to automatically [warmup](https://docs.sendgrid.com/ui/sending-email/warming-up-an-ip-address).

• is_parent_assignedbooleanObligatorio

  Indicates if a parent on the account is able to send email from the IP address.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• countintegerObligatorio

  The amount of IPs to add to the account.

• warmupboolean

  Whether or not to warmup the IPs being added.

• subusersstring[]

  Array of usernames to be assigned a send IP.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• ipsobject[]Obligatorio

  An array containing the IP(s) you want to allow.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• contactsobject[]Obligatorio

  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.

• list_idsstring[]

  An array of List ID strings that this contact will be added to.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• recipient_emailsstring[]Obligatorio

  The array of email addresses to add or find.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• group_idstringObligatorio

  The id of the unsubscribe group that you are adding suppressions to.

• recipient_emailsstring[]Obligatorio

  The array of email addresses to add or find.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• request_idstringObligatorio

  The ID of the request that you want to approve.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• ipstringObligatorio

  The `ip` path parameter specifies an IP address to make the request against.

• subusersstring[]Obligatorio

  An array of Subuser IDs to be assigned to the specified IP address. All Subuser assignments must succeed.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• link_idintegerObligatorio

  The ID of the branded link you want to associate.

• usernamestring

  The username of the subuser account that you want to associate the branded link with.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usernamestringObligatorio

  Username to associate with the authenticated domain.

• domain_idintegerObligatorio

  ID of the authenticated domain to associate with the subuser.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• ipsstring[]

  The IP addresses that will be included in the custom SPF record for this authenticated domain.

• domainstringObligatorio

  Domain being authenticated.

• regionstring

  The region of the domain. Allowed values are `global` and `eu`. The default value is `global`.

• defaultboolean

  Whether to use this authenticated domain as the fallback if no authenticated domains match the sender"s domain.

• usernamestring

  The username associated with this domain.

• subdomainstring

  The subdomain to use for this authenticated domain.

• custom_spfboolean

  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.

• automatic_securityboolean

  Whether to allow SendGrid to manage your SPF records, DKIM keys, and DKIM key rotation.

• custom_dkim_selectorstring

  Add a custom DKIM selector. Accepts three letters or numbers.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• accountIDstringObligatorio

  Twilio SendGrid account ID

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usernamestringObligatorio

  Username to associate with the authenticated domain.

• domain_idintegerObligatorio

  ID of the authenticated domain to associate with the subuser.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idsstring[]

  Single Send IDs to delete

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• statusstringObligatorioenum

  Status

  pausecancel
• batch_idstringObligatorio

  The batch ID is the identifier that your scheduled mail sends share.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• domainstringObligatorio

  The root domain for the subdomain that you are creating the link branding for. This should match your FROM email address.

• regionstringenum

  Region

  allglobaleu
• defaultboolean

  Default

• subdomainstring

  The subdomain to create the link branding for. Must be different from the subdomain you used for authenticating your domain.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• titlestringObligatorio

  The display title of your campaign. This will be viewable by you in the Marketing Campaigns UI.

• editorstringenum

  Editor

  codedesign
• ip_poolstring

  The pool of IPs that you would like to send this email from.

• subjectstring

  The subject of your campaign that your recipients will see.

• list_idsinteger[]

  The IDs of the lists you are sending this campaign to. You can have both segment IDs and list IDs

• sender_idinteger

  The ID of the "sender" identity that you have created. Your recipients will see this as the "from" on your marketing emails.

• categoriesstring[]

  The categories you would like associated to this campaign.

• segment_idsinteger[]

  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.

• html_contentstring

  The HTML of your marketing email.

• plain_contentstring

  The plain text content of your emails.

• suppression_group_idinteger

  The suppression group that this marketing email belongs to, allowing recipients to opt-out of emails of this type.

• custom_unsubscribe_urlstring

  This is the url of the custom unsubscribe page that you provide for customers to unsubscribe from your suppression groups.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  Name

• typestring

  Type

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• offeringsobject[]Obligatorio

  List of offering names to assign to account.

• profile__emailstring

  Email of the account holder

• profile__phonestring

  Phone number with a maximum of fifteen digits formatted using the E.164 standard consisting of [+] [country code] [subscriber number including area code]

• profile__timezonestring

  Area/Location as listed in the [IANA Time Zone database](https://www.iana.org/time-zones)

• profile__last__namestring

  Last name of the account holder

• profile__first__namestring

  First name of the account holder

• profile__company__namestring

  Company name of the account holder

• profile__company__websitestring

  Company website of the account holder

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• typestringObligatorioenum

  Type

  unlimitedrecurringnonrecurring
• email_tostringObligatorioemail

  The email address the alert will be sent to. Example: test@example.com

• frequencystring

  Required for stats_notification. How frequently the alert will be sent. Example: daily

• percentageinteger

  Required for usage_limit. When this usage threshold is reached, the alert will be sent. Example: 90

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• urlstringObligatorio

  Set this property to the URL where you want the Event Webhook to send event data.

• openboolean

  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.

• clickboolean

  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.

• bounceboolean

  Set this property to `true` to receive bounce events. A bounce occurs when a receiving server could not or would not accept a message.

• droppedboolean

  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.

• enabledboolean

  Set this property to `true` to enable the Event Webhook or `false` to disable it.

• deferredboolean

  Set this property to `true` to receive deferred events. Deferred events occur when a recipient"s email server temporarily rejects a message.

• deliveredboolean

  Set this property to `true` to receive delivered events. Delivered events occur when a message has been successfully delivered to the receiving server.

• processedboolean

  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.

• spam_reportboolean

  Set this property to `true` to receive spam report events. Spam reports occur when recipients mark a message as spam.

• unsubscribeboolean

  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.

• friendly_namestring

  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.

• oauth_client_idstring

  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.

• oauth_token_urlstring

  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.

• group_resubscribeboolean

  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.

• group_unsubscribeboolean

  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.

• oauth_client_secretstring

  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.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  The name of your suppression group. Required when creating a group.

• is_defaultboolean

  Indicates if you would like this to be your default suppression group.

• descriptionstring

  A brief description of your suppression group. Required when creating a group.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name of the transactional template version.

• activeinteger

  Active

• editorstringenum

  Editor

  codedesign
• subjectstringObligatorio

  Subject of the new transactional template version.

• test_datastring

  For dynamic templates only, the mock json data that will be used for template preview and test sends.

• template_idstringObligatorio

  Template Id

• html_contentstring

  The HTML content of the version. Maximum of 1048576 bytes allowed.

• plain_contentstring

  Text/plain content of the transactional template version. Maximum of 1048576 bytes allowed.

• generate_plain_contentboolean

  If true, plain_content is always generated from html_content. If false, plain_content is not altered.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name of your new IP pool.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• ipsstring[]

  An array of IP addresses to assign to the IP Pool. All assignments must succeed.

• namestringObligatorio

  The name to assign to the IP Pool. An IP Pool name cannot begin with a space or period.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• enabledboolean

  Indicates if the certificate is enabled.

• integration_idstringObligatorio

  An ID that matches a certificate to a specific IdP integration. This is the `id` returned by the "Get All SSO Integrations" endpoint.

• public_certificatestringObligatorio

  This public certificate allows SendGrid to verify that SAML requests it receives are signed by an IdP that it recognizes.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name of your integration. This name can be anything that makes sense for your organization (eg. Twilio SendGrid)

• enabledbooleanObligatorio

  Indicates if the integration is enabled.

• entity_idstringObligatorio

  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.

• signin_urlstringObligatorio

  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.

• signout_urlstringObligatorio

  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.

• completed_integrationboolean

  Indicates if the integration is complete.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailstringObligatorioemail

  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.

• scopesstring[]

  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.

• personastringenum

  Persona

  accountantdevelopermarketerobserver
• is_adminboolean

  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.

• last_namestringObligatorio

  Set this property to the Teammate"s last name.

• first_namestringObligatorio

  Set this property to the Teammate"s first name.

• subuser_accessobject[]

  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`.

• has_restricted_subuser_accessboolean

  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.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• urlstring

  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.

• hostnamestring

  A specific and unique domain or subdomain that you have created to use exclusively to parse your incoming email. For example, `parse.yourdomain.com`.

• send_rawboolean

  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.

• spam_checkboolean

  Indicates if you would like SendGrid to check the content parsed from your emails for spam before POSTing them to your domain.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name you will use to describe this API Key.

• scopesstring[]

  The individual permissions that you are giving to this API Key.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name of this segment.

• list_idinteger

  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.

• conditionsobject[]Obligatorio

  The conditions for a recipient to be included in this segment.

• recipient_countinteger

  The count of recipients in this list. This is not included on creation of segments.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• zipstring

  The zipcode of the Sender.

• citystringObligatorio

  The city of the Sender.

• statestring

  The state of the Sender.

• addressstringObligatorio

  The physical address of the Sender.

• countrystringObligatorio

  The country of the Sender.

• nicknamestringObligatorio

  A nickname for the Sender. Not used for sending.

• address_2string

  Additional Sender address information.

• from__namestring

  The name appended to the from email field. Typically your name or company name.

• from__emailstring

  The email address from which your recipient will receive emails.

• reply__to__namestring

  The name appended to the reply to email field. Typically your name or company name.

• reply__to__emailstring

  The email address to which your recipient will reply.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• zipstring

  The zipcode of the sender identity.

• citystringObligatorio

  The city of the sender identity.

• statestring

  The state of the sender identity.

• addressstringObligatorio

  The physical address of the sender identity.

• countrystringObligatorio

  The country of the sender identity.

• nicknamestringObligatorio

  A nickname for the sender identity. Not used for sending.

• address_2string

  Additional sender identity address information.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name for the new transactional template.

• generationstringenum

  Generation

  legacydynamic

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name

• field_typestringObligatorioenum

  Field Type

  TextNumberDate

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  The name of the new design.

• editorstringenum

  Editor

  codedesign
• html_contentstringObligatorio

  The HTML content of the Design.

• plain_contentstring

  Plain text content of the Design.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• labelstring

  The nickname for the Integration.

• destinationstringObligatorioenum

  Destination

  Segment
• filters__email__eventsstring[]

  The possible SendGrid email event types for event forwarding. Specify all the email event types that you would like to forward to the Integration"s destination.

• properties__write__keystring

  The write key provided by the Segment Source you"d like to have events forwarded to. Must be between 6 and 51 characters.

• properties__destination__regionstringenum

  Destination Region

  EUUS

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Your name for your list

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name of the segment.

• query_dslstringObligatorio

  SQL query which will filter contacts based on the conditions provided

• parent_list_idsstring[]

  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

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name of the Single Send.

• send_atstringdate-time

  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.

• categoriesstring[]

  The categories to associate with this Single Send.

• send__to__allboolean

  Set to `true` to send to All Contacts. If set to `false`, at least one `list_ids` or `segment_ids` value must be provided before the Single Send is scheduled to be sent to recipients.

• send__to__list__idsstring[]

  The recipient List IDs that will receive the Single Send.

• email__config__editorstringenum

  Editor

  codedesign
• email__config__subjectstring

  The subject line of the Single Send. Do not include this field when using a `design_id`.

• send__to__segment__idsstring[]

  The recipient Segment IDs that will receive the Single Send.

• email__config__ip__poolstring

  The name of the IP Pool from which the Single Send emails are sent.

• email__config__design__idstring

  A `design_id` can be used in place of `html_content`, `plain_content`, and/or `subject`. You can retrieve a design"s ID from the ["List Designs" endpoint](https://docs.sendgrid.com/api-reference/designs-api/list-designs) or by pulling it from the design"s detail page URL in the Marketing Campaigns App.

• email__config__sender__idinteger

  The ID of the verified Sender. You can retrieve a verified Sender"s ID from the ["Get Verified Senders" endpoint](https://www.twilio.com/docs/sendgrid/api-reference/sender-verification/get-all-verified-senders) or by pulling it from the Sender"s detail page URL in the SendGrid App.

• email__config__html__contentstring

  The HTML content of the Single Send. Do not include this field when using a `design_id`.

• email__config__plain__contentstring

  The plain text content of the Single Send. Do not include this field when using a `design_id`.

• email__config__suppression__group__idinteger

  The ID of the Suppression Group to allow recipients to unsubscribe — you must provide this or the `custom_unsubscribe_url`.

• email__config__custom__unsubscribe__urlstringuri

  The URL allowing recipients to unsubscribe — you must provide this or the `suppression_group_id`.

• email__config__generate__plain__contentboolean

  If set to `true`, `plain_content` is always generated from `html_content`. If set to false, `plain_content` is not altered.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• ipsstring[]Obligatorio

  The IP addresses that should be assigned to this subuser.

• emailstringObligatorioemail

  The email address of the subuser.

• regionstringenum

  Region

  globaleu
• passwordstringObligatorio

  The password this subuser will use when logging into SendGrid.

• usernamestringObligatorio

  The username for this subuser.

• include_regionboolean

  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.)

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• zipstring

  Zip

• citystring

  City

• statestring

  State

• addressstring

  Address

• countrystring

  Country

• address2string

  Address2

• nicknamestringObligatorio

  Nickname

• reply_tostringObligatorioemail

  Reply To

• from_namestring

  From Name

• from_emailstringObligatorioemail

  From Email

• reply_to_namestring

  Reply To Name

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• ipsstring[]Obligatorio

  An array of IP addresses to remove from the specified IP Pool.

• poolidstringObligatorio

  Specifies the unique ID for an IP Pool.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• ipstringObligatorio

  The `ip` path parameter specifies an IP address to make the request against.

• subusersstring[]Obligatorio

  An array of Subuser IDs to be removed from the specified IP address.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailstringObligatorio

  The email address you would like to remove from the bounce list.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idintegerObligatorio

  The ID of the branded link you want to retrieve.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• campaign_idintegerObligatorio

  The id of the campaign you would like to retrieve.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• batch_idstringObligatorio

  Batch Id

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• contact_idstringObligatorio

  Must be set to the `contact_id` of the contact you want to remove the identifier from.

• identifier_typestringObligatorioenum

  Identifier Type

  EMAILPHONENUMBERIDEXTERNALIDANONYMOUSID
• identifier_valuestringObligatorio

  The value of the identifier you want to remove from the contact.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• custom_field_idintegerObligatorio

  The ID of the custom field that you want to retrieve.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailstringObligatorio

  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.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• list_idintegerObligatorio

  List Id

• delete_contactsboolean

  Adds the ability to delete all contacts on the list in addition to deleting the list.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• accountIDstringObligatorio

  Twilio SendGrid account ID

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• alert_idintegerObligatorio

  The ID of the alert you would like to retrieve.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• domain_idstringObligatorio

  Domain Id

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pool_namestringObligatorio

  The name of the IP pool that you want to retrieve the IP addresses for.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• cert_idstringObligatorio

  Cert Id

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  Id

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• hostnamestringObligatorio

  The hostname associated with the inbound parse setting that you would like to retrieve.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• api_key_idstringObligatorio

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• recipient_idstringObligatorio

  The ID of the recipient that you want to retrieve.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The ID of the reverse DNS record that you would like to retrieve.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• segment_idintegerObligatorio

  Segment Id

• delete_contactsboolean

  True to delete all contacts matching the segment in addition to deleting the segment

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idintegerObligatorio

  The unique identifier of the Sender.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• sender_idintegerObligatorio

  The ID of the sender identity that you want to retrieve.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The ID of the Event Webhook you want to retrieve.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• list_idintegerObligatorio

  The ID of the list that you want to add the recipient to.

• recipient_idstringObligatorio

  The ID of the recipient you are adding to the list.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailstringObligatorio

  The email address of the specific block.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailstringObligatorio

  The specific email address of the invalid email entry that you want to retrieve.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailstringObligatorio

  The email address of a specific spam report that you want to retrieve.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• subuser_namestringObligatorio

  The username of the Subuser.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailstringObligatorio

  The email address that you want to remove from the suppression group.

• group_idstringObligatorio

  The id of the suppression group that you are removing an email address from.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• group_idstringObligatorio

  The ID of the suppression group you would like to retrieve.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• template_idstringObligatorio

  Template Id

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• version_idstringObligatorio

  The ID of the template version

• template_idstringObligatorio

  The ID of the original template

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailsstring[]

  The specific blocked email addresses that you want to delete.

• delete_allboolean

  Indicates if you want to delete all blocked email addresses.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailsstring[]

  Delete multiple emails from your bounce list at the same time. This should not be used with the delete_all parameter.

• delete_allboolean

  This parameter allows you to delete **every** email in your bounce list. This should not be used with the emails parameter.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idsstring[]Obligatorio

  Comma-delimited Integration IDs for the Integrations to delete.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idsstring

  A comma-separated list of contact IDs.

• delete_all_contactsstring

  Must be set to `"true"` to delete all contacts.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• custom_field_idstringObligatorio

  Custom Field Id

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The ID of the Design you want to duplicate.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailsstring[]

  The list of specific email addresses that you want to remove.

• delete_allboolean

  Indicates if you want to remove all email address from the invalid emails list.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• poolidstringObligatorio

  Specifies the unique ID for an IP Pool.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• tokenstringObligatorio

  The token for the invite you want to delete.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• segment_idstringObligatorio

  Segment Id

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  Id

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  Id

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailsstring[]

  A list of specific email addresses that you want to remove from the spam report list.

• delete_allboolean

  Indicates if you want to delete all email addresses on the spam report list.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usernamestringObligatorio

  The username of the teammate that you want to retrieve.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  Id

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• request_idstringObligatorio

  The ID of the request that you want to deny.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usernamestringObligatorio

  The username of the subuser account that you want to disassociate a branded link from.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usernamestring

  Username for the subuser to find associated authenticated domain.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• download_uuidstringObligatorio

  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

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  The name for the new transactional template.

• template_idstringObligatorio

  Template Id

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The ID of the Design you want to duplicate.

• namestring

  The name of the new design.

• editorstringenum

  Editor

  codedesign

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The ID of the pre-built Design you want to duplicate.

• namestring

  The name of the new design.

• editorstringenum

  Editor

  codedesign

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  Id

• namestring

  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.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• scopesstring[]

  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.

• personastringenum

  Persona

  accountantdevelopermarketerobserver
• is_adminboolean

  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.

• usernamestringObligatorio

  Set this parameter to the Teammate"s email address. This address must be the same address assigned to the Teammate in your IdP.

• last_namestringObligatorio

  Set this property to the Teammate"s last name.

• first_namestringObligatorio

  Set this property to the Teammate"s first name.

• subuser_accessobject[]

  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`.

• has_restricted_subuser_accessboolean

  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.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  The name of the transactional template.

• template_idstringObligatorio

  Template Id

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name of the transactional template version.

• activeinteger

  Active

• editorstringenum

  Editor

  codedesign
• subjectstringObligatorio

  Subject of the new transactional template version.

• test_datastring

  For dynamic templates only, the mock json data that will be used for template preview and test sends.

• version_idstringObligatorio

  The ID of the template version

• template_idstringObligatorio

  The ID of the original template

• html_contentstring

  The HTML content of the version. Maximum of 1048576 bytes allowed.

• plain_contentstring

  Text/plain content of the transactional template version. Maximum of 1048576 bytes allowed.

• generate_plain_contentboolean

  If true, plain_content is always generated from html_content. If false, plain_content is not altered.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  Id

• zipstring

  Zip

• citystring

  City

• statestring

  State

• addressstring

  Address

• countrystring

  Country

• address2string

  Address2

• nicknamestringObligatorio

  Nickname

• reply_tostringObligatorioemail

  Reply To

• from_namestring

  From Name

• from_emailstringObligatorioemail

  From Email

• reply_to_namestring

  Reply To Name

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailstringObligatorioemail

  The email address to send the DNS information to.

• link_idintegerObligatorio

  The ID of the branded link.

• messagestring

  A custom text block to include in the email body sent with the records.

• domain_idintegerObligatorio

  The ID of your SendGrid domain record.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• disabledboolean

  Whether or not this subuser is disabled. `true` means disabled, `false` means enabled.

• subuser_namestringObligatorio

  The username of the Subuser.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• disabledboolean

  Whether or not to disable website access to the Subuser. `true` means disabled, `false` means enabled.

• subuser_namestringObligatorio

  Subuser Name

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• email_addressesstring[]Obligatorio

  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.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• list_idsstring[]

  IDs of the contact lists you want to export.

• file_typestringenum

  File Type

  csvjson
• segment_idsstring[]

  IDs of the contact segments you want to export.

• max_file_sizeinteger

  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.

• notifications__emailboolean

  Email

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  Id

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idsstring[]

  The IDs of Single Sends for which to export stats.

• timezonestring

  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.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  The number of messages returned. This parameter must be greater than 0 and less than or equal to 1000

• querystringObligatorio

  Use the query syntax to filter your email activity.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• msg_idstringObligatorio

  The ID of the message you are requesting details for.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idsstring[]

  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.

• parent_list_idsstring

  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.

• no_parent_list_idboolean

  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".

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• accountIDstringObligatorio

  Twilio SendGrid account ID

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  Id

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The ID of the list on which you want to perform the operation.

• contact_sampleboolean

  Setting this parameter to the true will cause the contact_sample to be returned

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• ipstring

  Specifies an IP address. The `ip` query parameter can be used to filter results by IP address.

• poolstring

  Specifies the unique ID for an IP Pool. When included, only IP addresses belonging to the specified Pool will be returned.

• limitinteger

  Specifies the number of results to be returned by the API. This parameter can be used in combination with the `before_key` or `after_key` parameters to iterate through paginated results.

• regionstringenum

  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.

  alleuus
• after_keyinteger

  Specifies which items to be returned by the API. When the `after_key` is specified, the API will return items beginning from the first item after the item specified. This parameter can be used in combination with `limit` to iterate through paginated results.

• is_leasedboolean

  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.

• before_keystring

  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.

• is_enabledboolean

  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.

• end_added_atinteger

  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.

• include_regionboolean

  Boolean indicating whether or not to return the IP Pool"s region information in the response.

• start_added_atinteger

  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.

• is_parent_assignedboolean

  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.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• ipstringObligatorio

  The `ip` path parameter specifies an IP address to make the request against.

• limitinteger

  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.

• after_keyinteger

  Specifies which items to be returned by the API. When the `after_key` is specified, the API will return items beginning from the first item after the item specified. This parameter can be used in combination with `limit` to iterate through paginated results.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  The number of items to return

• offsetstring

  The last item successfully retrieved

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• page_sizeinteger

  The number of elements you want returned on each page.

• page_tokenstring

  The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn"t exist, you"re at the first page. Similarly, if `_metadata.next` is not present, you"re at the last page.

• automation_idsstring[]

  This endpoint returns all automation IDs if no `automation_ids` are specified.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• ipstring

  Specifies an IP address. The `ip` query parameter can be used to filter results by IP address.

• limitinteger

  Specifies the number of results to be returned by the API. This parameter can be used in combination with the `before_key` or `after_key` parameters to iterate through paginated results.

• regionstringenum

  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.

  alleuus
• after_keyinteger

  Specifies which items to be returned by the API. When the `after_key` is specified, the API will return items beginning from the first item after the item specified. This parameter can be used in combination with `limit` to iterate through paginated results.

• include_regionboolean

  Boolean indicating whether or not to return the IP Pool"s region information in the response.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• page_sizeinteger

  Maximum number of elements to return. Defaults to 100, returns 1000 max

• page_tokenstring

  Page Token

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• page_sizeinteger

  Page Size

• page_tokenstring

  Page Token

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• page_sizeinteger

  The number of elements you want returned on each page.

• page_tokenstring

  The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn"t exist, you"re at the first page. Similarly, if `_metadata.next` is not present, you"re at the last page.

• singlesend_idsstring[]

  This endpoint returns all Single Send IDs if no IDs are included in `singlesend_ids`.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• integration_idstringObligatorio

  An ID that matches a certificate to a specific IdP integration.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• siboolean

  If this parameter is set to `true`, the response will include the `completed_integration` field.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idinteger

  Returns information about only the Sender Identity passed in the request.

• limitinteger

  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.

• lastSeenIDinteger

  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.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• accountIDstringObligatorio

  Twilio SendGrid account ID

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• cert_idstringObligatorio

  Cert Id

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  Id

• siboolean

  If this parameter is set to `true`, the response will include the `completed_integration` field.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idintegerObligatorio

  The unique identifier of the Sender.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The ID of the Automation you want to get click tracking stats for.

• group_bystring[]

  Automations can have multiple steps. Including `step_id` as a `group_by` metric allows further granularity of stats.

• step_idsstring[]

  Comma-separated list of `step_ids` that you want the link stats for.

• page_sizeinteger

  The number of elements you want returned on each page.

• page_tokenstring

  The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn"t exist, you"re at the first page. Similarly, if `_metadata.next` is not present, you"re at the last page.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  The ID of the Automation for which you want to retrieve statistics.

• end_datestring

  Format: `YYYY-MM-DD`.If this parameter is included, the stats" end date is included in the search.

• group_bystring[]

  Automations can have multiple steps. Including `step_id` as a `group_by` metric allows further granularity of stats.

• step_idsstring[]

  Comma-separated list of `step_ids` that you want the link stats for.

• timezonestring

  [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".

• page_sizeinteger

  The number of elements you want returned on each page.

• page_tokenstring

  The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn"t exist, you"re at the first page. Similarly, if `_metadata.next` is not present, you"re at the last page.

• start_datestring

  Format: `YYYY-MM-DD`. If this parameter is included, the stats" start date is included in the search.

• aggregated_bystringenum

  Dictates how the stats are time-sliced. Currently, `"total"` and `"day"` are supported.

  dayweekmonth

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idsstring[]Obligatorio

  Ids

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• end_datestring

  The end of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).

• start_datestring

  The start of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).

• classificationstringObligatorioenum

  The classification you want to filter by. Possible values are: `Content`, `Frequency or Volume Too High`, `Invalid Address`, `Mailbox Unavailable`, `Reputation`, `Technical Failure`, `Unclassified`.

  ContentFrequency or Volume Too HighInvalid AddressMailbox UnavailableReputationTechnical FailureUnclassified

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailsstring[]Obligatorio

  One or more primary and/or alternate email addresses to search for in your Marketing Campaigns contacts.

• external_idstring

  The contact"s External ID.

• anonymous_idstring

  The contact"s Anonymous ID.

• phone_number_idstring

  The contact"s Phone Number ID. This is required to be a valid phone number.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not