# README

Go API client for

The Twilio SendGrid Legacy Marketing Campaigns Contacts API allows you to manage your marketing contacts programmatically. This API is operational, but we recommend using the current version of Marketing Campaigns' Contacts API, Lists API, and Segments API to manage your contacts.

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:27.724777Z[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
AddRecipient	AddRecipient	Post /v3/contactdb/recipients	Add recipients
AddRecipientToContactDbList	AddRecipientToContactDbList	Post /v3/contactdb/lists/{ListId}/recipients/{RecipientId}	Add a Single Recipient to a List
AddRecipientsToContactDbList	AddRecipientsToContactDbList	Post /v3/contactdb/lists/{ListId}/recipients	Add Multiple Recipients to a List
CreateContactDbList	CreateContactDbList	Post /v3/contactdb/lists	Create a List
CreateCustomField	CreateCustomField	Post /v3/contactdb/custom_fields	Create a Custom Field
CreateSegment	CreateSegment	Post /v3/contactdb/segments	Create a Segment
DeleteContactDbList	DeleteContactDbList	Delete /v3/contactdb/lists/{ListId}	Delete a List
DeleteContactDbLists	DeleteContactDbLists	Delete /v3/contactdb/lists	Delete Multiple lists
DeleteCustomField	DeleteCustomField	Delete /v3/contactdb/custom_fields/{CustomFieldId}	Delete a Custom Field
DeleteRecipient	DeleteRecipient	Delete /v3/contactdb/recipients/{RecipientId}	Delete a Recipient
DeleteRecipientFromContactDbList	DeleteRecipientFromContactDbList	Delete /v3/contactdb/lists/{ListId}/recipients/{RecipientId}	Delete a Single Recipient from a Single List
DeleteRecipients	DeleteRecipients	Delete /v3/contactdb/recipients	Delete Recipients
DeleteSegment	DeleteSegment	Delete /v3/contactdb/segments/{SegmentId}	Delete a segment
ExportRecipient	ExportRecipient	Post /v3/contactdb/exports	Export Recipients
GetBillable	GetBillable	Get /v3/contactdb/recipients/billable_count	Retrieve the count of billable recipients
GetContactDbList	GetContactDbList	Get /v3/contactdb/lists/{ListId}	Retrieve a single list
GetCustomField	GetCustomField	Get /v3/contactdb/custom_fields/{CustomFieldId}	Retrieve a Custom Field
GetExportRecipient	GetExportRecipient	Get /v3/contactdb/exports/{Id}	Export Recipients Status
GetRecipient	GetRecipient	Get /v3/contactdb/recipients/{RecipientId}	Retrieve a single recipient
GetRecipientList	GetRecipientList	Get /v3/contactdb/recipients/{RecipientId}/lists	Retrieve the lists that a recipient is on
GetSegment	GetSegment	Get /v3/contactdb/segments/{SegmentId}	Retrieve a segment
ListContactDbList	ListContactDbList	Get /v3/contactdb/lists	Retrieve all lists
ListCustomField	ListCustomField	Get /v3/contactdb/custom_fields	Retrieve all custom fields
ListExportRecipient	ListExportRecipient	Get /v3/contactdb/exports	Get All Existing Exports
ListRecipient	ListRecipient	Get /v3/contactdb/recipients	Retrieve recipients
ListRecipientCount	ListRecipientCount	Get /v3/contactdb/recipients/count	Retrieve a Count of Recipients
ListRecipientForSegment	ListRecipientForSegment	Get /v3/contactdb/segments/{SegmentId}/recipients	Retrieve recipients on a segment
ListRecipientsFromContactDbList	ListRecipientsFromContactDbList	Get /v3/contactdb/lists/{ListId}/recipients	Retrieve all recipients on a List
ListReservedField	ListReservedField	Get /v3/contactdb/reserved_fields	Retrieve reserved fields
ListSearchRecipient	ListSearchRecipient	Get /v3/contactdb/recipients/search	Search recipients
ListSegment	ListSegment	Get /v3/contactdb/segments	Retrieve all segments
ListStatus	ListStatus	Get /v3/contactdb/status	Get Recipient Upload Status
SearchRecipient	SearchRecipient	Post /v3/contactdb/recipients/search	Search recipients
UpdateContactDbList	UpdateContactDbList	Patch /v3/contactdb/lists/{ListId}	Update a List
UpdateRecipient	UpdateRecipient	Patch /v3/contactdb/recipients	Update Recipient
UpdateSegment	UpdateSegment	Patch /v3/contactdb/segments/{SegmentId}	Update a segment

Documentation For Models

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)