Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Update Integration



API Overview

api-overview page anchor

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(link takes you to an external page) 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.


PATCH/v3/marketing/integrations/{id}

Base url: https://api.sendgrid.com

This endpoint updates an existing Integration.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
idstringrequired

The ID of the Integration you would like to update.

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.


propertiesobjectOptional

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


labelstringOptional

The nickname for the Integration.

Default: Untitled Integration
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.


propertiesobject

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


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

update-an-integration page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_22
const client = require('@sendgrid/client');
_22
client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22
const id = "ZGkrHSypTsudrGkmdpJJ";
_22
const data = {
_22
"label": "My New Segment Integration!"
_22
};
_22
_22
const request = {
_22
url: `/v3/marketing/integrations/${id}`,
_22
method: 'PATCH',
_22
body: data
_22
}
_22
_22
client.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
});


Rate this page: