Menu

Expand
Rate this page:

Settings - Partner

Elements that can be shared among more than one endpoint definition.

Returns a list of all partner settings.

Effective August 30, 2022, Twilio SendGrid will remove New Relic integrations. Please use Deliverability Insights to view your email statistics and visualizations.

GET /v3/partner_settings

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

This endpoint allows you to retrieve a list of all partner settings that you can enable.

Our partner settings allow you to integrate your SendGrid account with our partners to increase your SendGrid experience and functionality. For more information about our partners, and how you can begin integrating with them, please visit our Partners documentation.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

default: None

Query String

limit
integer

The number of settings to return per page.

default: None
offset
integer

The paging offset.

default: None

Responses

object
result
array[object]
title
string

The title of the partner.

required
enabled
boolean

Indicates if this partner setting has been enabled.

required
name
string

The name of the partner setting.

required
description
string

A description of this partner setting.

required
Loading Code Sample...
        
        

        Returns a list of all partner settings.

        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

        Loading Code Sample...
              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              thanks-feedback-gif