Skip to content Skip to navigation Skip to topbar

Update Integration

API Overview

An Integration is a connection from a SendGrid Marketing Campaign to a supported third-party application. Integrations with different external applications allow you to sync data and create a more cohesive cross-product data experience.

Currently, only Segment Integrations are supported. Segment Integrations allow you to customize and automate email event forwarding to your Segment account.

The Integrations API allows you to create, retrieve, update, and delete your Integrations.

Operation overview

PATCH/v3/marketing/integrations/{id}

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint updates an existing Integration.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

Property nameTypeRequiredDescription

idstringrequired

The ID of the Integration you would like to update.

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

destinationenum<string>Optional

The third-party application you would like to forward your email events to.

Possible values:

Segment

filtersobjectOptional

The configurable filters for SendGrid to destination email event forwarding.

Show child properties for filters

propertiesobjectOptional

The properties of an Integration required to send events to a specific third-party application.

Show child properties for properties

labelstringOptional

The nickname for the Integration.

Default: Untitled Integration

Responses

200400403404500

Successful Operation

SchemaExample

Property nameTypeRequiredDescriptionChild properties

integration_idstring

The unique ID of an Integration.

user_idstring

Your Twilio SendGrid account ID.

filtersobject

The configurable filters for SendGrid to destination email event forwarding.

Show child properties for filters

propertiesobject

The properties of an Integration required to send events to a specific third-party application.

Show child properties for properties

labelstring

The nickname for the Integration.

Default: Untitled Integration

destinationenum<string>

The third-party application you would like to forward your events to.

Possible values:

Segment

Update an Integration

Node.js

Python

Java

PHP

Ruby

curl


_22const client = require('@sendgrid/client');
_22client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22const id = "ZGkrHSypTsudrGkmdpJJ";
_22const data = {
_22  "label": "My New Segment Integration!"
_22};
_22
_22const request = {
_22  url: `/v3/marketing/integrations/${id}`,
_22  method: 'PATCH',
_22  body: data
_22}
_22
_22client.request(request)
_22  .then(([response, body]) => {
_22    console.log(response.statusCode);
_22    console.log(response.body);
_22  })
_22  .catch(error => {
_22    console.error(error);
_22  });