Menu

Expand
Rate this page:

Campaigns API

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

Retrieve a single campaign

GET /v3/campaigns/{campaign_id}

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

This endpoint allows you to retrieve a specific campaign.

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

Path Parameters

campaign_id
integer

The id of the campaign you would like to retrieve.

default: None
required

Responses

object
categories
array[string]
custom_unsubscribe_url
string
html_content
string
id
integer
ip_pool
string
list_ids
array[integer]
plain_content
string
segment_ids
array[integer]
sender_id
integer
status
string
subject
string
suppression_group_id
integer
title
string
object
object
Loading Code Sample...
        
        

        Retrieve a single campaign

        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