Menu

Campaigns API

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

Retrieve a single campaign

GET /campaigns/{campaign_id}

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
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

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
Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.

Thank you for your feedback!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

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

Thanks for your feedback!

Refer us and get $10 in 3 simple steps!

Step 1

Get link

Get a free personal referral link here

Step 2

Give $10

Your user signs up and upgrade using link

Step 3

Get $10

1,250 free SMSes
OR 1,000 free voice mins
OR 12,000 chats
OR more