api

package

Go to main page

Versions in this module

v0

v0.3.0

Apr 27, 2026

Changes in this version

type CampaignCreateResponse

+ EmailMessageContentRevisionID *string

+ type CampaignListItem struct

+ CampaignID string

+ CreatedAt string

+ EmailMessageID *string

+ Name string

+ Status string

+ Subject string

+ UpdatedAt string

type Client

+ func (c *Client) UpdateCampaign(id string, req UpdateCampaignRequest) (*Campaign, error)

+ type UpdateCampaignRequest struct

+ Name string

v0.2.1

Apr 23, 2026

Changes in this version

+ type Campaign struct

+ CampaignID string

+ CreatedAt string

+ EmailMessageID *string

+ Name string

+ Status string

+ Subject string

+ UpdatedAt string

+ type CampaignCreateResponse struct

+ CampaignID string

+ CreatedAt string

+ EmailMessage *EmailMessage

+ Name string

+ Status string

+ UpdatedAt string

+ Warnings []LmxWarning

type Client

+ func (c *Client) CreateCampaign(req CreateCampaignRequest) (*CampaignCreateResponse, error)

+ func (c *Client) GetCampaign(id string) (*Campaign, error)

+ func (c *Client) GetEmailMessage(id string) (*EmailMessage, error)

+ func (c *Client) ListCampaigns(params PaginationParams) ([]Campaign, *Pagination, error)

+ func (c *Client) UpdateEmailMessage(id string, req UpdateEmailMessageRequest) (*EmailMessage, error)

+ type CreateCampaignRequest struct

+ EmailMessage *EmailMessageFields

+ Name string

+ type EmailMessage struct

+ CampaignID *string

+ ContentRevisionID *string

+ EmailMessageID string

+ FromEmail string

+ FromName string

+ LMX string

+ PreviewText string

+ ReplyToEmail string

+ Subject string

+ UpdatedAt string

+ Warnings []LmxWarning

+ type EmailMessageFields struct

+ FromEmail string

+ FromName string

+ LMX string

+ PreviewText string

+ ReplyToEmail string

+ Subject string

+ type LmxWarning struct

+ Message string

+ Path string

+ Rule string

+ Severity string

+ type UpdateEmailMessageRequest struct

+ ExpectedRevisionID string

+ Set map[string]bool

v0.2.1-0

Apr 21, 2026

v0.2.0

Apr 21, 2026

v0.1.0

Apr 17, 2026

v0.1.0-0

Apr 17, 2026

v0.0.5

Apr 17, 2026

v0.0.4

Apr 16, 2026

Changes in this version

type Contact

+ Custom map[string]any

+ func (c *Contact) UnmarshalJSON(data []byte) error

+ func (c Contact) MarshalJSON() ([]byte, error)

v0.0.3

Apr 7, 2026

v0.0.2

Apr 2, 2026

Changes in this version

type Client

+ func (c *Client) CheckContactSuppression(email, userID string) (*ContactSuppression, error)

+ func (c *Client) RemoveContactSuppression(email, userID string) (*ContactSuppressionRemoval, error)

+ type ContactSuppression struct

+ Contact struct{ ... }

+ IsSuppressed bool

+ RemovalQuota struct{ ... }

+ type ContactSuppressionRemoval struct

+ Message string

+ RemovalQuota struct{ ... }

+ Success bool

v0.0.1

Apr 1, 2026

Changes in this version

+ func Paginate[T any](fetch func(cursor string) ([]T, *Pagination, error)) ([]T, error)

+ type APIError struct

+ Message string

+ StatusCode int

+ func (e *APIError) Error() string

+ type APIKeyResponse struct

+ TeamName string

+ type Attachment struct

+ ContentType string

+ Data string

+ Filename string

+ type Client struct

+ func NewClient(baseURL, apiKey string, debug bool) *Client

+ func (c *Client) CreateContact(req CreateContactRequest) (string, error)

+ func (c *Client) CreateContactProperty(name, propType string) error

+ func (c *Client) DeleteContact(email, userID string) error

+ func (c *Client) FindContacts(params FindContactParams) ([]Contact, error)

+ func (c *Client) GetAPIKey() (*APIKeyResponse, error)

+ func (c *Client) ListContactProperties(customOnly bool) ([]ContactProperty, error)

+ func (c *Client) ListMailingLists() ([]MailingList, error)

+ func (c *Client) ListTransactional(params PaginationParams) ([]TransactionalEmail, *Pagination, error)

+ func (c *Client) SendEvent(req SendEventRequest) error

+ func (c *Client) SendTransactional(req SendTransactionalRequest) error

+ func (c *Client) UpdateContact(req UpdateContactRequest) error

+ func (c *Client) WithUserAgent(ua string) *Client

+ type Contact struct

+ Email string

+ FirstName *string

+ ID string

+ LastName *string

+ MailingLists map[string]bool

+ OptInStatus *string

+ Source string

+ Subscribed bool

+ UserGroup string

+ UserID *string

+ type ContactProperty struct

+ Key string

+ Label string

+ Type string

+ type CreateContactRequest struct

+ ContactProperties map[string]any

+ Email string

+ FirstName string

+ LastName string

+ MailingLists map[string]bool

+ Source string

+ Subscribed *bool

+ UserGroup string

+ UserID string

+ type FindContactParams struct

+ Email string

+ UserID string

+ type MailingList struct

+ Description string

+ ID string

+ IsPublic bool

+ Name string

+ type Pagination struct

+ NextCursor string

+ NextPage string

+ PerPage int

+ ReturnedResults int

+ TotalPages int

+ TotalResults int

+ type PaginationParams struct

+ Cursor string

+ PerPage string

+ type SendEventRequest struct

+ ContactProperties map[string]any

+ Email string

+ EventName string

+ EventProperties map[string]any

+ IdempotencyKey string

+ MailingLists map[string]bool

+ UserID string

+ type SendTransactionalRequest struct

+ AddToAudience *bool

+ Attachments []Attachment

+ DataVariables map[string]any

+ Email string

+ IdempotencyKey string

+ TransactionalID string

+ type TransactionalEmail struct

+ DataVariables []string

+ ID string

+ LastUpdated string

+ Name string

+ type UpdateContactRequest struct

+ ContactProperties map[string]any

+ Email string

+ FirstName string

+ LastName string

+ MailingLists map[string]bool

+ Subscribed *bool

+ UserGroup string

+ UserID string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL