# README
Go API client for
The Twilio SendGrid Legacy Marketing Campaigns Campaigns API allows you to manage your marketing email messages programmatically. This API is operational, but we recommend using the current version of Marketing Campaigns to manage your marketing messages with SendGrid Single Sends and Automations.
See Migrating from Legacy Marketing Campaigns for more information.
Overview
This API client was generated by the OpenAPI Generator project from the OpenAPI specs located at twilio/sendgrid-oai. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 1.0.0
- Package version:
- Build date: 2025-08-18T08:58:25.318681Z[Etc/UTC]
- Build package: com.sendgrid.oai.go.SendgridGoGenerator For more information, please visit https://support.sendgrid.com/hc/en-us
Installation
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/net/context
Put the package under your project folder and add the following in import:
import "./"
Documentation for API Endpoints
All URIs are relative to https://api.sendgrid.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| CreateCampaign | CreateCampaign | Post /v3/campaigns | Create a Campaign |
| DeleteCampaign | DeleteCampaign | Delete /v3/campaigns/{CampaignId} | Delete a Campaign |
| GetCampaign | GetCampaign | Get /v3/campaigns/{CampaignId} | Retrieve a single campaign |
| GetScheduledCampaign | GetScheduledCampaign | Get /v3/campaigns/{CampaignId}/schedules | View Scheduled Time of a Campaign |
| ListCampaign | ListCampaign | Get /v3/campaigns | Retrieve all Campaigns |
| ScheduleCampaign | ScheduleCampaign | Post /v3/campaigns/{CampaignId}/schedules | Schedule a Campaign |
| SendCampaign | SendCampaign | Post /v3/campaigns/{CampaignId}/schedules/now | Send a Campaign |
| SendTestCampaign | SendTestCampaign | Post /v3/campaigns/{CampaignId}/schedules/test | Send a Test Campaign |
| UnScheduleCampaign | UnScheduleCampaign | Delete /v3/campaigns/{CampaignId}/schedules | Unschedule a Scheduled Campaign |
| UpdateCampaign | UpdateCampaign | Patch /v3/campaigns/{CampaignId} | Update a Campaign |
| UpdateScheduledCampaign | UpdateScheduledCampaign | Patch /v3/campaigns/{CampaignId}/schedules | Update a Scheduled Campaign |
Documentation For Models
- Campaigns2xx
- Editor
- ErrorResponse
- ErrorResponseErrorsInner
- GetCampaign200Response
- ListCampaign200Response
- PostCampaignsRequest
- ScheduleACampaignRequest
- ScheduleACampaignResponse
- SendACampaignResponse
- SendATestCampaignRequest
- SendTestCampaignRequest
- Status
- UpdateACampaignRequest
- UpdateAScheduledCampaignRequest
- UpdateAScheduledCampaignResponse
- ViewScheduledTimeOfACampaignResponse
Documentation For Authorization
BearerAuth
- Type: HTTP basic authentication
Example
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)