← Twilio SendGrid

Add or Update Contact with Twilio SendGrid API

Pipedream makes it easy to connect APIs for Twilio SendGrid and 800+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Add or Update Contact with the Twilio SendGrid API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to Add or Update Contact with the Twilio SendGrid API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Add or Update Contact action
    1. Connect your Twilio SendGrid account
    2. Optional- Select one or more List Ids
    3. Select a Email
    4. Optional- Configure First Name
    5. Optional- Configure Last Name
    6. Optional- Configure Address Line 1
    7. Optional- Configure Address Line 2
    8. Optional- Configure Alternate Emails
    9. Optional- Configure City
    10. Optional- Configure Country
    11. Optional- Configure Postal Code
    12. Optional- Configure State Province Region
    13. Optional- Configure Custom Fields
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Add or Update Contact on Twilio SendGrid
Description:Adds or updates a contact. [See the docs here](https://docs.sendgrid.com/api-reference/contacts/add-or-update-a-contact)
Version:0.0.1
Key:sendgrid-add-or-update-contact

Code

import validate from "validate.js";
import common from "../common.mjs";

export default {
  ...common,
  key: "sendgrid-add-or-update-contact",
  name: "Add or Update Contact",
  description: "Adds or updates a contact. [See the docs here](https://docs.sendgrid.com/api-reference/contacts/add-or-update-a-contact)",
  version: "0.0.1",
  type: "action",
  props: {
    ...common.props,
    listIds: {
      propDefinition: [
        common.props.sendgrid,
        "listIds",
      ],
    },
    email: {
      propDefinition: [
        common.props.sendgrid,
        "contactEmail",
      ],
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "The contact's personal name",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "The contact's family name",
      optional: true,
    },
    addressLine1: {
      type: "string",
      label: "Address Line 1",
      description: "The first line of the address",
      optional: true,
    },
    addressLine2: {
      type: "string",
      label: "Address Line 2",
      description: "An optional second line for the address",
      optional: true,
    },
    alternateEmails: {
      type: "string[]",
      label: "Alternate Emails",
      description: "Additional emails associated with the contact",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "The contact's city.",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description:
        "The contact's country. Can be a full name or an abbreviation",
      optional: true,
    },
    postalCode: {
      type: "string",
      label: "Postal Code",
      description: "The contact's ZIP code or other postal code",
      optional: true,
    },
    stateProvinceRegion: {
      type: "string",
      label: "State Province Region",
      description: "The contact's state, province, or region",
      optional: true,
    },
    customFields: {
      type: "object",
      label: "Custom Fields",
      description: "Custom fields for the contact",
      optional: true,
    },
  },
  async run({ $ }) {
    validate.validators.arrayValidator = this.validateArray;
    const constraints = {
      email: {
        presence: true,
        email: true,
      },
    };
    if (this.listIds) {
      constraints.listIds = {
        type: "array",
      };
    }
    if (this.alternateEmails) {
      constraints.cc = {
        type: "array",
      };
    }
    const validationResult = validate(
      {
        email: this.email,
        listIds: this.listIds,
        alternateEmails: this.alternateEmails,
      },
      constraints,
    );
    this.checkValidationResults(validationResult);
    const contacts = [
      {
        email: this.email,
        address_line_1: this.addressLine1,
        address_line_2: this.addressLine2,
        alternate_emails: this.alternateEmails,
        city: this.city,
        country: this.country,
        first_name: this.firstName,
        last_name: this.lastName,
        postal_code: this.postalCode,
        state_province_region: this.stateProvinceRegion,
        custom_fields: this.customFields,
      },
    ];
    const config = this.omitEmptyStringValues({
      list_ids: this.listIds,
      contacts,
    });
    const resp = await this.sendgrid.addOrUpdateContacts(config);
    $.export("$summary", "Successfully added/updated contact");
    return resp;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
Twilio SendGridsendgridappThis component uses the Twilio SendGrid app.
List IdslistIdsstring[]Select a value from the drop down menu.
EmailemailstringSelect a value from the drop down menu.
First NamefirstNamestring

The contact's personal name

Last NamelastNamestring

The contact's family name

Address Line 1addressLine1string

The first line of the address

Address Line 2addressLine2string

An optional second line for the address

Alternate EmailsalternateEmailsstring[]

Additional emails associated with the contact

Citycitystring

The contact's city.

Countrycountrystring

The contact's country. Can be a full name or an abbreviation

Postal CodepostalCodestring

The contact's ZIP code or other postal code

State Province RegionstateProvinceRegionstring

The contact's state, province, or region

Custom FieldscustomFieldsobject

Custom fields for the contact

Authentication

Twilio SendGrid uses API keys for authentication. When you connect your Twilio SendGrid account, Pipedream securely stores the keys so you can easily authenticate to Twilio SendGrid APIs in both code and no-code steps.

Enter your Sendgrid API key below

About Twilio SendGrid

Delivering your transactional and marketing emails through the world's largest cloud-based email delivery platform. Send with confidence.