Files
sdk/docs/MarketingAPI.md

188 KiB

\MarketingAPI

All URIs are relative to https://api.hanzo.ai

Method HTTP request Description
DeleteMarketingAudiencesById Delete /v1/marketing/audiences/{id} Removes one of the caller org's audiences and answers 204.
DeleteMarketingBroadcastsById Delete /v1/marketing/broadcasts/{id} Deletes a broadcast that is not sending, with its record of who it went to, and answers 204.
DeleteMarketingCalendarById Delete /v1/marketing/calendar/{id} Removes one of the caller org's posts and answers 204.
DeleteMarketingCampaignsById Delete /v1/marketing/campaigns/{id} Removes one of the caller org's campaigns and answers 204.
DeleteMarketingListsById Delete /v1/marketing/lists/{id} Deletes one of the org's lists with every subscriber, segment, import and broadcast it has, and answers 204.
DeleteMarketingListsByIdSegmentsBySid Delete /v1/marketing/lists/{id}/segments/{sid} Deletes a saved segment and answers 204.
DeleteMarketingListsByIdSubscribersBySid Delete /v1/marketing/lists/{id}/subscribers/{sid} Removes one subscriber from one of the org's lists and answers 204.
DeleteMarketingSuppressions Delete /v1/marketing/suppressions Re-subscribes an address on one channel and answers 204.
GetMarketingAudiences Get /v1/marketing/audiences Returns every audience the org can send to: its saved cohorts, most recently updated first, then its mailing lists and their saved segments, newest first, each list with its subscribed count.
GetMarketingAudiencesById Get /v1/marketing/audiences/{id} Returns one of the caller org's saved audiences.
GetMarketingAudiencesByIdPreview Get /v1/marketing/audiences/{id}/preview Evaluates the cohort LIVE — the same resolution an enrollment would run — and reports how big it is and how many real mailboxes it reaches.
GetMarketingBeta Get /v1/marketing/beta Answers the signed-in caller's waitlist record: the application as it stands, the betas asked for, the points and the actions that earned them, and the place on the waitlist.
GetMarketingBetaInvites Get /v1/marketing/beta/invites Answers the caller's invites, newest first, with how many were sent, how many joined, and how many more they may send now.
GetMarketingBroadcasts Get /v1/marketing/broadcasts Returns the org's broadcasts, newest first.
GetMarketingBroadcastsById Get /v1/marketing/broadcasts/{id} Returns one of the org's broadcasts.
GetMarketingBroadcastsByIdStats Get /v1/marketing/broadcasts/{id}/stats Returns one broadcast's numbers: audience, sent, refused, failed, and what the email plane reported (delivered, opened, clicked, bounced, complained, unsubscribed), each counted once per message, with open and click rates.
GetMarketingCalendar Get /v1/marketing/calendar Returns the org's calendar, latest scheduled first, optionally narrowed to one status.
GetMarketingCalendarById Get /v1/marketing/calendar/{id} Returns one of the caller org's posts, including the exact error behind a failed publish.
GetMarketingCampaigns Get /v1/marketing/campaigns Returns the org's campaigns, most recently updated first, optionally narrowed to one lifecycle status.
GetMarketingCampaignsById Get /v1/marketing/campaigns/{id} Returns one of the caller org's campaigns.
GetMarketingClick Get /v1/marketing/click Follows a tracked email link.
GetMarketingFields Get /v1/marketing/fields Returns the custom fields the org defined for its subscribers.
GetMarketingImports Get /v1/marketing/imports Returns the org's imports, newest first, each with its report.
GetMarketingImportsById Get /v1/marketing/imports/{id} Returns one of the org's imports: its state, how far its bytes and its reading have come, and its report so far.
GetMarketingLists Get /v1/marketing/lists Returns the org's lists, newest first, each with its subscribers counted by status.
GetMarketingListsById Get /v1/marketing/lists/{id} Returns one of the org's lists, by id or slug, with its subscribers counted by status.
GetMarketingListsByIdExport Get /v1/marketing/lists/{id}/export Streams a selection of one list as CSV (format=csv, the default) or as a JSON array (format=json), every subscriber with their consent evidence, engagement and custom fields.
GetMarketingListsByIdSegments Get /v1/marketing/lists/{id}/segments Returns one list's saved segments, newest first.
GetMarketingListsByIdStats Get /v1/marketing/lists/{id}/stats Returns one list's numbers for charting: subscribers by status, source and consent basis, and over a range of days, what happened each day, the net growth, the confirmation rate and the unsubscribe rate.
GetMarketingListsByIdSubscribers Get /v1/marketing/lists/{id}/subscribers Returns a page of one list's subscribers, newest first unless asked otherwise.
GetMarketingListsByIdSubscribersBySid Get /v1/marketing/lists/{id}/subscribers/{sid} Returns one subscriber of one of the org's lists, with their consent evidence and engagement.
GetMarketingPromos Get /v1/marketing/promos Returns every promo the deployment offers with its live counters: how many orgs have redeemed it and how many redemptions remain under the cap.
GetMarketingPromosByCodeEligibility Get /v1/marketing/promos/{code}/eligibility Prices a promo against a plan and seat count.
GetMarketingPromosByCodeRedemption Get /v1/marketing/promos/{code}/redemption Returns the caller org's OWN redemption of a promo — an org-scoped read, so it can never surface another tenant's.
GetMarketingSender Get /v1/marketing/sender Returns the org's sender: the provider and the from, reply and footer fields every list takes when it leaves its own empty.
GetMarketingSequences Get /v1/marketing/sequences Returns the org's drip sequences, most recently updated first.
GetMarketingSequencesById Get /v1/marketing/sequences/{id} Returns one of the caller org's sequences together with its steps in send order.
GetMarketingSequencesByIdEnrollments Get /v1/marketing/sequences/{id}/enrollments Returns who is walking one sequence, most recently enrolled first, with each walk's current step and next due time.
GetMarketingSequencesByIdSteps Get /v1/marketing/sequences/{id}/steps Returns one sequence's steps in send order.
GetMarketingSummary Get /v1/marketing/summary Rolls up the caller org's campaigns: how many there are, how many are active, and the summed budget and spend in cents.
GetMarketingSuppressions Get /v1/marketing/suppressions Returns the org's opt-out list, newest first — everyone the send gate will refuse to deliver to.
GetMarketingSuppressionsCheck Get /v1/marketing/suppressions/check Answers whether the org's send gate refuses an address, and which list holds it, by the same check every commercial send asks.
GetMarketingUnsubscribe Get /v1/marketing/unsubscribe Is the PUBLIC one-click endpoint (no principal): a recipient clicks the signed link in an email footer.
PatchMarketingBroadcastsById Patch /v1/marketing/broadcasts/{id} Changes the fields the body names on a draft or scheduled broadcast and answers it.
PatchMarketingListsById Patch /v1/marketing/lists/{id} Changes the fields the body names on one of the org's lists and answers the list.
PatchMarketingListsByIdSubscribersBySid Patch /v1/marketing/lists/{id}/subscribers/{sid} Changes the fields the body names on one subscriber and answers the row.
PostMarketingAudiences Post /v1/marketing/audiences Saves a cohort filter for the caller's org.
PostMarketingBetaActions Post /v1/marketing/beta/actions Counts one action of the signed-in caller: a star on a Hanzo repository, verified on GitHub for the login named, or a follow of a founder's link, taken on trust.
PostMarketingBetaInvites Post /v1/marketing/beta/invites Reserves an invite for each address the limits admit and answers the message the member's mailbox sends for each: subject, text and HTML, the unsubscribe headers, with the member's referral link for that invite and a one-click unsubscribe for that address.
PostMarketingBetaInvitesSent Post /v1/marketing/beta/invites/sent Records what the member's browser did with its reservations: the invites sent, and the ones that failed with the mailbox's reason.
PostMarketingBetaRequest Post /v1/marketing/beta/request Adds betas to those the signed-in caller asked for, creating the record when there is none.
PostMarketingBroadcasts Post /v1/marketing/broadcasts Composes a broadcast to one of the org's lists, or a segment of it, and answers 201 with it.
PostMarketingBroadcastsByIdCancel Post /v1/marketing/broadcasts/{id}/cancel Stops a scheduled or sending broadcast and answers it.
PostMarketingBroadcastsByIdSend Post /v1/marketing/broadcasts/{id}/send Sends a draft or scheduled broadcast now, or schedules it for at, and answers 202 with it.
PostMarketingBroadcastsByIdTest Post /v1/marketing/broadcasts/{id}/test Sends the broadcast as it stands to up to five addresses, its subject marked [Test], through the same rail and footer the real send takes.
PostMarketingCalendar Post /v1/marketing/calendar Adds a post to the content calendar.
PostMarketingCampaigns Post /v1/marketing/campaigns Registers a campaign in the caller's org.
PostMarketingCampaignsByIdSchedule Post /v1/marketing/campaigns/{id}/schedule Sets a campaign's send time and moves it to "scheduled".
PostMarketingImports Post /v1/marketing/imports Creates an import into one of the org's lists and answers it.
PostMarketingImportsByIdCancel Post /v1/marketing/imports/{id}/cancel Stops an import that has not finished and answers it.
PostMarketingImportsByIdStart Post /v1/marketing/imports/{id}/start Queues an import whose bytes have all arrived and answers 202 with it; a worker reads it from there.
PostMarketingLeads Post /v1/marketing/leads Files one public form in the deployment's own CRM.
PostMarketingLeadsEsign Post /v1/marketing/leads/esign Takes Hanzo eSign's webhook: a SAFE was signed, countersigned, completed, declined or voided, and the investor's form in the brand's CRM moves to that status.
PostMarketingLeadsResume Post /v1/marketing/leads/resume Signs a form the careers page posts one resume through, into the brand org's private careers bucket, and answers the key to name on the application (`resume_file`).
PostMarketingLists Post /v1/marketing/lists Creates a list in the org and answers 201 with it.
PostMarketingListsByIdSegments Post /v1/marketing/lists/{id}/segments Saves a filter over one list as a segment and answers 201 with it and how many subscribers it selects now.
PostMarketingListsByIdSubscribers Post /v1/marketing/lists/{id}/subscribers Adds an address to one of the org's lists, or updates it when it is already there, and answers 201 or 200 with the row.
PostMarketingListsByIdSubscribersBulk Post /v1/marketing/lists/{id}/subscribers/bulk Applies one action to a selection of a list and answers how many rows it matched and changed.
PostMarketingMail Post /v1/marketing/mail Sends one email from the org to one person, the way a person on the org's team writes back to a lead from its record.
PostMarketingPromosByCodeRedeem Post /v1/marketing/promos/{code}/redeem Records the caller org's claim on a promo.
PostMarketingSequences Post /v1/marketing/sequences Registers a drip sequence in the caller's org.
PostMarketingSequencesByIdEnroll Post /v1/marketing/sequences/{id}/enroll Adds one contact or a whole audience to a sequence and schedules the first step for each.
PostMarketingSequencesByIdEnrollmentsByEidCancel Post /v1/marketing/sequences/{id}/enrollments/{eid}/cancel Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled.
PostMarketingSequencesByIdStatus Post /v1/marketing/sequences/{id}/status Flips draft/active/archived — the activation gate for sending, since only an active sequence accepts enrollments.
PostMarketingSequencesByIdSteps Post /v1/marketing/sequences/{id}/steps Appends a message to the END of a sequence: the new step's idx is one past the last, so steps arrive in the order they are added.
PostMarketingSubscribe Post /v1/marketing/subscribe Asks for the brand's newsletter for an address and answers 202 pending.
PostMarketingSubscribeConfirm Post /v1/marketing/subscribe/confirm Subscribes the address a confirmation link names and answers 200 confirmed.
PostMarketingSuppressions Post /v1/marketing/suppressions Records an opt-out for the org (admin / self-service management).
PostMarketingUnsubscribe Post /v1/marketing/unsubscribe Is the one-click unsubscribe a mail client sends from the List-Unsubscribe header (RFC 8058): the same signed link the footer carries, POSTed with the form body List-Unsubscribe=One-Click.
PutMarketingBeta Put /v1/marketing/beta Writes the signed-in caller's application: the program, the answers, the betas asked for and the lead it was filed under.
PutMarketingCalendarById Put /v1/marketing/calendar/{id} Replaces a post's editable fields.
PutMarketingCampaignsById Put /v1/marketing/campaigns/{id} Replaces a campaign's editable fields.
PutMarketingFields Put /v1/marketing/fields Replaces the org's custom fields with the set the body carries and answers it.
PutMarketingImportsByIdData Put /v1/marketing/imports/{id}/data Takes a piece of an import's file at the offset the query names and answers how many bytes the import now holds.
PutMarketingListsByIdSegmentsBySid Put /v1/marketing/lists/{id}/segments/{sid} Replaces a segment's name and filter and answers it with how many subscribers it selects now.
PutMarketingSender Put /v1/marketing/sender Replaces the org's sender and answers it.

DeleteMarketingAudiencesById

DeleteMarketingAudiencesById(ctx, id).Execute()

Removes one of the caller org's audiences and answers 204.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "aud_4c1e9b7a2d6f0538e4a7c9b1d3f5027a" // string | ID is the audience id from the path, as returned by create.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.MarketingAPI.DeleteMarketingAudiencesById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.DeleteMarketingAudiencesById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the audience id from the path, as returned by create.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteMarketingAudiencesByIdRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMarketingBroadcastsById

map[string]interface{} DeleteMarketingBroadcastsById(ctx, id).Execute()

Deletes a broadcast that is not sending, with its record of who it went to, and answers 204.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "brd_7a3c1e9b5d2f4068a1c3e5b7" // string | ID is the broadcast's id.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.DeleteMarketingBroadcastsById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.DeleteMarketingBroadcastsById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteMarketingBroadcastsById`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.DeleteMarketingBroadcastsById`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the broadcast's id.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteMarketingBroadcastsByIdRequest struct via the builder pattern

Name Type Description Notes

Return type

map[string]interface{}

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMarketingCalendarById

DeleteMarketingCalendarById(ctx, id).Execute()

Removes one of the caller org's posts and answers 204.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "cal_1d7f3b9e5a2c8046f1b3d5a7c9e02468" // string | ID is the post id from the path, as returned by create.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.MarketingAPI.DeleteMarketingCalendarById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.DeleteMarketingCalendarById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the post id from the path, as returned by create.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteMarketingCalendarByIdRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMarketingCampaignsById

DeleteMarketingCampaignsById(ctx, id).Execute()

Removes one of the caller org's campaigns and answers 204.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "camp_9f2a1c7d4e8b0a6f3d2c5b1e7a9f4c60" // string | ID is the campaign id from the path, as returned by create.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.MarketingAPI.DeleteMarketingCampaignsById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.DeleteMarketingCampaignsById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the campaign id from the path, as returned by create.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteMarketingCampaignsByIdRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMarketingListsById

map[string]interface{} DeleteMarketingListsById(ctx, id).Execute()

Deletes one of the org's lists with every subscriber, segment, import and broadcast it has, and answers 204.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "lst_5f1c2e9a7b3d4c6e8f0a1b2c" // string | ID is the list's id or its slug.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.DeleteMarketingListsById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.DeleteMarketingListsById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteMarketingListsById`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.DeleteMarketingListsById`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the list's id or its slug.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteMarketingListsByIdRequest struct via the builder pattern

Name Type Description Notes

Return type

map[string]interface{}

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMarketingListsByIdSegmentsBySid

map[string]interface{} DeleteMarketingListsByIdSegmentsBySid(ctx, id, sid).Execute()

Deletes a saved segment and answers 204.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "newsletter" // string | ID is the list, by id or slug.
	sid := "seg_0b7e3c1a9d2f4e6a8c0b1d3e" // string | SID is the segment's id.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.DeleteMarketingListsByIdSegmentsBySid(context.Background(), id, sid).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.DeleteMarketingListsByIdSegmentsBySid``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteMarketingListsByIdSegmentsBySid`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.DeleteMarketingListsByIdSegmentsBySid`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the list, by id or slug.
sid string SID is the segment's id.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteMarketingListsByIdSegmentsBySidRequest struct via the builder pattern

Name Type Description Notes

Return type

map[string]interface{}

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMarketingListsByIdSubscribersBySid

map[string]interface{} DeleteMarketingListsByIdSubscribersBySid(ctx, id, sid).Execute()

Removes one subscriber from one of the org's lists and answers 204.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "newsletter" // string | ID is the list, by id or slug.
	sid := int64(1842) // int64 | SID is the subscriber's id.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.DeleteMarketingListsByIdSubscribersBySid(context.Background(), id, sid).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.DeleteMarketingListsByIdSubscribersBySid``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteMarketingListsByIdSubscribersBySid`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.DeleteMarketingListsByIdSubscribersBySid`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the list, by id or slug.
sid int64 SID is the subscriber's id.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteMarketingListsByIdSubscribersBySidRequest struct via the builder pattern

Name Type Description Notes

Return type

map[string]interface{}

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMarketingSuppressions

DeleteMarketingSuppressions(ctx).Channel(channel).Address(address).Execute()

Re-subscribes an address on one channel and answers 204.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	channel := "email" // string | Channel is the surface the entry opts out of; empty is email. (optional)
	address := "[email protected]" // string | Address is the entry: an address, or \"@example.com\" for a company. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.MarketingAPI.DeleteMarketingSuppressions(context.Background()).Channel(channel).Address(address).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.DeleteMarketingSuppressions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiDeleteMarketingSuppressionsRequest struct via the builder pattern

Name Type Description Notes
channel string Channel is the surface the entry opts out of; empty is email.
address string Address is the entry: an address, or "@example.com" for a company.

Return type

(empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingAudiences

MarketingAudienceList GetMarketingAudiences(ctx).Limit(limit).Execute()

Returns every audience the org can send to: its saved cohorts, most recently updated first, then its mailing lists and their saved segments, newest first, each list with its subscribed count.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	limit := int64(50) // int64 | Limit caps the rows returned; 0 means 200 and nothing above 1000 is honoured. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingAudiences(context.Background()).Limit(limit).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingAudiences``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingAudiences`: MarketingAudienceList
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingAudiences`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingAudiencesRequest struct via the builder pattern

Name Type Description Notes
limit int64 Limit caps the rows returned; 0 means 200 and nothing above 1000 is honoured.

Return type

MarketingAudienceList

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingAudiencesById

MarketingAudience GetMarketingAudiencesById(ctx, id).Execute()

Returns one of the caller org's saved audiences.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "aud_4c1e9b7a2d6f0538e4a7c9b1d3f5027a" // string | ID is the audience id from the path, as returned by create.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingAudiencesById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingAudiencesById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingAudiencesById`: MarketingAudience
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingAudiencesById`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the audience id from the path, as returned by create.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingAudiencesByIdRequest struct via the builder pattern

Name Type Description Notes

Return type

MarketingAudience

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingAudiencesByIdPreview

MarketingAudiencePreview GetMarketingAudiencesByIdPreview(ctx, id).Execute()

Evaluates the cohort LIVE — the same resolution an enrollment would run — and reports how big it is and how many real mailboxes it reaches.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "aud_4c1e9b7a2d6f0538e4a7c9b1d3f5027a" // string | ID is the audience id from the path, as returned by create.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingAudiencesByIdPreview(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingAudiencesByIdPreview``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingAudiencesByIdPreview`: MarketingAudiencePreview
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingAudiencesByIdPreview`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the audience id from the path, as returned by create.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingAudiencesByIdPreviewRequest struct via the builder pattern

Name Type Description Notes

Return type

MarketingAudiencePreview

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingBeta

MarketingBeta GetMarketingBeta(ctx).Execute()

Answers the signed-in caller's waitlist record: the application as it stands, the betas asked for, the points and the actions that earned them, and the place on the waitlist.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingBeta(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingBeta``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingBeta`: MarketingBeta
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingBeta`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingBetaRequest struct via the builder pattern

Return type

MarketingBeta

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingBetaInvites

MarketingBetaInviteList GetMarketingBetaInvites(ctx).Execute()

Answers the caller's invites, newest first, with how many were sent, how many joined, and how many more they may send now.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingBetaInvites(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingBetaInvites``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingBetaInvites`: MarketingBetaInviteList
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingBetaInvites`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingBetaInvitesRequest struct via the builder pattern

Return type

MarketingBetaInviteList

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingBroadcasts

MarketingBroadcastPage GetMarketingBroadcasts(ctx).List(list).Status(status).Limit(limit).Execute()

Returns the org's broadcasts, newest first.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	list := "newsletter" // string | List keeps one list's broadcasts, by id or slug. (optional)
	status := "sent" // string | Status keeps broadcasts in one status. (optional)
	limit := int64(789) // int64 | Limit is the page size, 50 by default and at most 200. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingBroadcasts(context.Background()).List(list).Status(status).Limit(limit).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingBroadcasts``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingBroadcasts`: MarketingBroadcastPage
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingBroadcasts`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingBroadcastsRequest struct via the builder pattern

Name Type Description Notes
list string List keeps one list's broadcasts, by id or slug.
status string Status keeps broadcasts in one status.
limit int64 Limit is the page size, 50 by default and at most 200.

Return type

MarketingBroadcastPage

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingBroadcastsById

MarketingBroadcast GetMarketingBroadcastsById(ctx, id).Execute()

Returns one of the org's broadcasts.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "brd_7a3c1e9b5d2f4068a1c3e5b7" // string | ID is the broadcast's id.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingBroadcastsById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingBroadcastsById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingBroadcastsById`: MarketingBroadcast
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingBroadcastsById`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the broadcast's id.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingBroadcastsByIdRequest struct via the builder pattern

Name Type Description Notes

Return type

MarketingBroadcast

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingBroadcastsByIdStats

MarketingBroadcastStats GetMarketingBroadcastsByIdStats(ctx, id).Execute()

Returns one broadcast's numbers: audience, sent, refused, failed, and what the email plane reported (delivered, opened, clicked, bounced, complained, unsubscribed), each counted once per message, with open and click rates.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "brd_7a3c1e9b5d2f4068a1c3e5b7" // string | ID is the broadcast's id.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingBroadcastsByIdStats(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingBroadcastsByIdStats``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingBroadcastsByIdStats`: MarketingBroadcastStats
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingBroadcastsByIdStats`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the broadcast's id.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingBroadcastsByIdStatsRequest struct via the builder pattern

Name Type Description Notes

Return type

MarketingBroadcastStats

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingCalendar

MarketingPostList GetMarketingCalendar(ctx).Status(status).Limit(limit).Execute()

Returns the org's calendar, latest scheduled first, optionally narrowed to one status.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	status := "scheduled" // string | Status keeps only posts in that state (draft, scheduled, published, failed, canceled). Empty means every post. (optional)
	limit := int64(50) // int64 | Limit caps the rows returned; 0 means 200 and nothing above 1000 is honoured. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingCalendar(context.Background()).Status(status).Limit(limit).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingCalendar``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingCalendar`: MarketingPostList
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingCalendar`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingCalendarRequest struct via the builder pattern

Name Type Description Notes
status string Status keeps only posts in that state (draft, scheduled, published, failed, canceled). Empty means every post.
limit int64 Limit caps the rows returned; 0 means 200 and nothing above 1000 is honoured.

Return type

MarketingPostList

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingCalendarById

MarketingCalendarPost GetMarketingCalendarById(ctx, id).Execute()

Returns one of the caller org's posts, including the exact error behind a failed publish.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "cal_1d7f3b9e5a2c8046f1b3d5a7c9e02468" // string | ID is the post id from the path, as returned by create.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingCalendarById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingCalendarById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingCalendarById`: MarketingCalendarPost
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingCalendarById`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the post id from the path, as returned by create.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingCalendarByIdRequest struct via the builder pattern

Name Type Description Notes

Return type

MarketingCalendarPost

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingCampaigns

MarketingCampaignList GetMarketingCampaigns(ctx).Status(status).Limit(limit).Execute()

Returns the org's campaigns, most recently updated first, optionally narrowed to one lifecycle status.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	status := "active" // string | Status keeps only campaigns in that lifecycle state (draft, scheduled, active, paused, completed). Empty means every campaign. (optional)
	limit := int64(25) // int64 | Limit caps the rows returned; 0 means 200 and nothing above 1000 is honoured. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingCampaigns(context.Background()).Status(status).Limit(limit).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingCampaigns``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingCampaigns`: MarketingCampaignList
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingCampaigns`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingCampaignsRequest struct via the builder pattern

Name Type Description Notes
status string Status keeps only campaigns in that lifecycle state (draft, scheduled, active, paused, completed). Empty means every campaign.
limit int64 Limit caps the rows returned; 0 means 200 and nothing above 1000 is honoured.

Return type

MarketingCampaignList

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingCampaignsById

MarketingCampaign GetMarketingCampaignsById(ctx, id).Execute()

Returns one of the caller org's campaigns.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "camp_9f2a1c7d4e8b0a6f3d2c5b1e7a9f4c60" // string | ID is the campaign id from the path, as returned by create.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingCampaignsById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingCampaignsById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingCampaignsById`: MarketingCampaign
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingCampaignsById`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the campaign id from the path, as returned by create.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingCampaignsByIdRequest struct via the builder pattern

Name Type Description Notes

Return type

MarketingCampaign

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingClick

ProblemDetails GetMarketingClick(ctx).UserAgent(userAgent).T(t).Execute()

Follows a tracked email link.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	userAgent := "userAgent_example" // string | Agent is the clicker's User-Agent header. Only its family (chrome, safari, automated, …) is kept. (optional)
	t := "AQGAgICAAQVoYW56bw…" // string | T is the click token the send minted for this link and this recipient: base64url, signed under the deployment's KMS key marketing/click-hmac. It is the request's only authority. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingClick(context.Background()).UserAgent(userAgent).T(t).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingClick``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingClick`: ProblemDetails
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingClick`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingClickRequest struct via the builder pattern

Name Type Description Notes
userAgent string Agent is the clicker's User-Agent header. Only its family (chrome, safari, automated, …) is kept.
t string T is the click token the send minted for this link and this recipient: base64url, signed under the deployment's KMS key marketing/click-hmac. It is the request's only authority.

Return type

ProblemDetails

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingFields

MarketingFieldSet GetMarketingFields(ctx).Execute()

Returns the custom fields the org defined for its subscribers.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingFields(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingFields``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingFields`: MarketingFieldSet
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingFields`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingFieldsRequest struct via the builder pattern

Return type

MarketingFieldSet

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingImports

MarketingImportPage GetMarketingImports(ctx).List(list).Limit(limit).Execute()

Returns the org's imports, newest first, each with its report.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	list := "newsletter" // string | List keeps one list's imports, by id or slug. (optional)
	limit := int64(20) // int64 | Limit is the page size, 50 by default and at most 200. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingImports(context.Background()).List(list).Limit(limit).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingImports``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingImports`: MarketingImportPage
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingImports`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingImportsRequest struct via the builder pattern

Name Type Description Notes
list string List keeps one list's imports, by id or slug.
limit int64 Limit is the page size, 50 by default and at most 200.

Return type

MarketingImportPage

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingImportsById

MarketingImport GetMarketingImportsById(ctx, id).Execute()

Returns one of the org's imports: its state, how far its bytes and its reading have come, and its report so far.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "imp_4c1e9a7b3d2f0e6a8c1b5d7e" // string | ID is the import's id.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingImportsById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingImportsById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingImportsById`: MarketingImport
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingImportsById`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the import's id.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingImportsByIdRequest struct via the builder pattern

Name Type Description Notes

Return type

MarketingImport

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingLists

MarketingListPage GetMarketingLists(ctx).Execute()

Returns the org's lists, newest first, each with its subscribers counted by status.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingLists(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingLists``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingLists`: MarketingListPage
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingLists`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingListsRequest struct via the builder pattern

Return type

MarketingListPage

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingListsById

MarketingList GetMarketingListsById(ctx, id).Execute()

Returns one of the org's lists, by id or slug, with its subscribers counted by status.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "newsletter" // string | ID is the list's id or its slug.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingListsById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingListsById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingListsById`: MarketingList
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingListsById`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the list's id or its slug.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingListsByIdRequest struct via the builder pattern

Name Type Description Notes

Return type

MarketingList

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingListsByIdExport

GetMarketingListsByIdExport(ctx, id).Execute()

Streams a selection of one list as CSV (format=csv, the default) or as a JSON array (format=json), every subscriber with their consent evidence, engagement and custom fields.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "id_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.MarketingAPI.GetMarketingListsByIdExport(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingListsByIdExport``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingListsByIdExportRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingListsByIdSegments

MarketingSegmentPage GetMarketingListsByIdSegments(ctx, id).Execute()

Returns one list's saved segments, newest first.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "newsletter" // string | ID is the list's id or its slug.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingListsByIdSegments(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingListsByIdSegments``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingListsByIdSegments`: MarketingSegmentPage
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingListsByIdSegments`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the list's id or its slug.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingListsByIdSegmentsRequest struct via the builder pattern

Name Type Description Notes

Return type

MarketingSegmentPage

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingListsByIdStats

MarketingListStats GetMarketingListsByIdStats(ctx, id).From(from).To(to).Execute()

Returns one list's numbers for charting: subscribers by status, source and consent basis, and over a range of days, what happened each day, the net growth, the confirmation rate and the unsubscribe rate.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "newsletter" // string | ID is the list, by id or slug, from the path.
	from := "2026-10-01" // string | From is the first day, YYYY-MM-DD (UTC); 30 days before To by default. (optional)
	to := "2026-10-31" // string | To is the last day, YYYY-MM-DD (UTC); today by default. At most 366 days after From. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingListsByIdStats(context.Background(), id).From(from).To(to).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingListsByIdStats``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingListsByIdStats`: MarketingListStats
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingListsByIdStats`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the list, by id or slug, from the path.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingListsByIdStatsRequest struct via the builder pattern

Name Type Description Notes

from | string | From is the first day, YYYY-MM-DD (UTC); 30 days before To by default. | to | string | To is the last day, YYYY-MM-DD (UTC); today by default. At most 366 days after From. |

Return type

MarketingListStats

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingListsByIdSubscribers

MarketingSubscriberPage GetMarketingListsByIdSubscribers(ctx, id).Status(status).Tag(tag).Source(source).Ref(ref).Basis(basis).Q(q).Field(field).Value(value).CreatedAfter(createdAfter).CreatedBefore(createdBefore).ConfirmedAfter(confirmedAfter).ConfirmedBefore(confirmedBefore).OpenedAfter(openedAfter).NotOpenedSince(notOpenedSince).ClickedAfter(clickedAfter).Segment(segment).Sort(sort).Order(order).Cursor(cursor).Limit(limit).Execute()

Returns a page of one list's subscribers, newest first unless asked otherwise.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "newsletter" // string | ID is the list, by id or slug, from the path.
	status := "subscribed" // string | Status is one status or several, comma-separated: pending, subscribed, unsubscribed, bounced, complained, cleaned. (optional)
	tag := "beta" // string | Tag keeps subscribers carrying this tag. (optional)
	source := "source_example" // string | Source keeps subscribers that came from this kind of source: form, page, api, import or commerce. (optional)
	ref := "ref_example" // string | Ref keeps subscribers from one source instance: a form id, a page, an import batch id. (optional)
	basis := "basis_example" // string | Basis keeps subscribers by the consent basis recorded for them: explicit, legitimate_interest or unverified. (optional)
	q := "q_example" // string | Q keeps subscribers whose address or name begins with it, case-insensitively. A search is ordered by address. (optional)
	field := "field_example" // string | Field names a custom field, and Value keeps subscribers whose value for it is exactly this. (optional)
	value := "value_example" // string | Value is the custom field's value Field keeps. (optional)
	createdAfter := int64(789) // int64 | CreatedAfter and CreatedBefore bound when the subscriber joined the list, unix seconds, inclusive. Zero is unbounded. (optional)
	createdBefore := int64(789) // int64 | CreatedBefore is the upper bound of CreatedAfter's range. (optional)
	confirmedAfter := int64(789) // int64 | ConfirmedAfter and ConfirmedBefore bound when the subscription was confirmed, unix seconds, inclusive. (optional)
	confirmedBefore := int64(789) // int64 | ConfirmedBefore is the upper bound of ConfirmedAfter's range. (optional)
	openedAfter := int64(789) // int64 | OpenedAfter keeps subscribers who opened a broadcast at or after this time. (optional)
	notOpenedSince := int64(789) // int64 | NotOpenedSince keeps subscribers who have opened nothing since this time, including those who never opened anything. (optional)
	clickedAfter := int64(789) // int64 | ClickedAfter keeps subscribers who clicked a link at or after this time. (optional)
	segment := "segment_example" // string | Segment applies a saved segment of the list; the filter fields narrow it further. (optional)
	sort := "sort_example" // string | Sort is created (the default), email, name, confirmed or opened. A search (q) is always by address. (optional)
	order := "order_example" // string | Order is desc (the default) or asc. (optional)
	cursor := "cursor_example" // string | Cursor continues from where the previous page ended. (optional)
	limit := int64(50) // int64 | Limit is the page size, 50 by default and at most 500. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingListsByIdSubscribers(context.Background(), id).Status(status).Tag(tag).Source(source).Ref(ref).Basis(basis).Q(q).Field(field).Value(value).CreatedAfter(createdAfter).CreatedBefore(createdBefore).ConfirmedAfter(confirmedAfter).ConfirmedBefore(confirmedBefore).OpenedAfter(openedAfter).NotOpenedSince(notOpenedSince).ClickedAfter(clickedAfter).Segment(segment).Sort(sort).Order(order).Cursor(cursor).Limit(limit).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingListsByIdSubscribers``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingListsByIdSubscribers`: MarketingSubscriberPage
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingListsByIdSubscribers`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the list, by id or slug, from the path.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingListsByIdSubscribersRequest struct via the builder pattern

Name Type Description Notes

status | string | Status is one status or several, comma-separated: pending, subscribed, unsubscribed, bounced, complained, cleaned. | tag | string | Tag keeps subscribers carrying this tag. | source | string | Source keeps subscribers that came from this kind of source: form, page, api, import or commerce. | ref | string | Ref keeps subscribers from one source instance: a form id, a page, an import batch id. | basis | string | Basis keeps subscribers by the consent basis recorded for them: explicit, legitimate_interest or unverified. | q | string | Q keeps subscribers whose address or name begins with it, case-insensitively. A search is ordered by address. | field | string | Field names a custom field, and Value keeps subscribers whose value for it is exactly this. | value | string | Value is the custom field's value Field keeps. | createdAfter | int64 | CreatedAfter and CreatedBefore bound when the subscriber joined the list, unix seconds, inclusive. Zero is unbounded. | createdBefore | int64 | CreatedBefore is the upper bound of CreatedAfter's range. | confirmedAfter | int64 | ConfirmedAfter and ConfirmedBefore bound when the subscription was confirmed, unix seconds, inclusive. | confirmedBefore | int64 | ConfirmedBefore is the upper bound of ConfirmedAfter's range. | openedAfter | int64 | OpenedAfter keeps subscribers who opened a broadcast at or after this time. | notOpenedSince | int64 | NotOpenedSince keeps subscribers who have opened nothing since this time, including those who never opened anything. | clickedAfter | int64 | ClickedAfter keeps subscribers who clicked a link at or after this time. | segment | string | Segment applies a saved segment of the list; the filter fields narrow it further. | sort | string | Sort is created (the default), email, name, confirmed or opened. A search (q) is always by address. | order | string | Order is desc (the default) or asc. | cursor | string | Cursor continues from where the previous page ended. | limit | int64 | Limit is the page size, 50 by default and at most 500. |

Return type

MarketingSubscriberPage

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingListsByIdSubscribersBySid

MarketingSubscriber GetMarketingListsByIdSubscribersBySid(ctx, id, sid).Execute()

Returns one subscriber of one of the org's lists, with their consent evidence and engagement.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "newsletter" // string | ID is the list, by id or slug.
	sid := int64(1842) // int64 | SID is the subscriber's id.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingListsByIdSubscribersBySid(context.Background(), id, sid).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingListsByIdSubscribersBySid``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingListsByIdSubscribersBySid`: MarketingSubscriber
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingListsByIdSubscribersBySid`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the list, by id or slug.
sid int64 SID is the subscriber's id.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingListsByIdSubscribersBySidRequest struct via the builder pattern

Name Type Description Notes

Return type

MarketingSubscriber

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingPromos

MarketingPromoList GetMarketingPromos(ctx).Execute()

Returns every promo the deployment offers with its live counters: how many orgs have redeemed it and how many redemptions remain under the cap.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingPromos(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingPromos``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingPromos`: MarketingPromoList
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingPromos`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingPromosRequest struct via the builder pattern

Return type

MarketingPromoList

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingPromosByCodeEligibility

MarketingQuote GetMarketingPromosByCodeEligibility(ctx, code).Plan(plan).Seats(seats).Execute()

Prices a promo against a plan and seat count.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	code := "first1000" // string | Code is the promo code from the path.
	plan := "team" // string | Plan is the plan being priced: pro, max or team. Anything else (including the free Developer plan) has no list price and so nothing to discount. (optional)
	seats := int64(12) // int64 | Seats is the Team seat count; 0 means 1, and it is ignored for the single-seat plans. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingPromosByCodeEligibility(context.Background(), code).Plan(plan).Seats(seats).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingPromosByCodeEligibility``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingPromosByCodeEligibility`: MarketingQuote
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingPromosByCodeEligibility`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
code string Code is the promo code from the path.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingPromosByCodeEligibilityRequest struct via the builder pattern

Name Type Description Notes

plan | string | Plan is the plan being priced: pro, max or team. Anything else (including the free Developer plan) has no list price and so nothing to discount. | seats | int64 | Seats is the Team seat count; 0 means 1, and it is ignored for the single-seat plans. |

Return type

MarketingQuote

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingPromosByCodeRedemption

MarketingRedemption GetMarketingPromosByCodeRedemption(ctx, code).Execute()

Returns the caller org's OWN redemption of a promo — an org-scoped read, so it can never surface another tenant's.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	code := "first1000" // string | Code is the promo code from the path, e.g. \"first1000\".

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingPromosByCodeRedemption(context.Background(), code).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingPromosByCodeRedemption``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingPromosByCodeRedemption`: MarketingRedemption
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingPromosByCodeRedemption`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
code string Code is the promo code from the path, e.g. "first1000".

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingPromosByCodeRedemptionRequest struct via the builder pattern

Name Type Description Notes

Return type

MarketingRedemption

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingSender

MarketingSender GetMarketingSender(ctx).Execute()

Returns the org's sender: the provider and the from, reply and footer fields every list takes when it leaves its own empty.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingSender(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingSender``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingSender`: MarketingSender
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingSender`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingSenderRequest struct via the builder pattern

Return type

MarketingSender

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingSequences

MarketingSequenceList GetMarketingSequences(ctx).Limit(limit).Execute()

Returns the org's drip sequences, most recently updated first.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	limit := int64(50) // int64 | Limit caps the rows returned; 0 means 200 and nothing above 1000 is honoured. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingSequences(context.Background()).Limit(limit).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingSequences``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingSequences`: MarketingSequenceList
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingSequences`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingSequencesRequest struct via the builder pattern

Name Type Description Notes
limit int64 Limit caps the rows returned; 0 means 200 and nothing above 1000 is honoured.

Return type

MarketingSequenceList

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingSequencesById

MarketingSequenceView GetMarketingSequencesById(ctx, id).Execute()

Returns one of the caller org's sequences together with its steps in send order.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "seq_7b3e5a1c9d024f68b0a3e7c5d9f1a248" // string | ID is the sequence id from the path, as returned by create.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingSequencesById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingSequencesById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingSequencesById`: MarketingSequenceView
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingSequencesById`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the sequence id from the path, as returned by create.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingSequencesByIdRequest struct via the builder pattern

Name Type Description Notes

Return type

MarketingSequenceView

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingSequencesByIdEnrollments

MarketingEnrollmentList GetMarketingSequencesByIdEnrollments(ctx, id).Limit(limit).Execute()

Returns who is walking one sequence, most recently enrolled first, with each walk's current step and next due time.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "seq_7b3e5a1c9d024f68b0a3e7c5d9f1a248" // string | ID is the sequence id from the path.
	limit := int64(100) // int64 | Limit caps the rows returned; 0 means 200 and nothing above 1000 is honoured. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingSequencesByIdEnrollments(context.Background(), id).Limit(limit).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingSequencesByIdEnrollments``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingSequencesByIdEnrollments`: MarketingEnrollmentList
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingSequencesByIdEnrollments`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the sequence id from the path.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingSequencesByIdEnrollmentsRequest struct via the builder pattern

Name Type Description Notes

limit | int64 | Limit caps the rows returned; 0 means 200 and nothing above 1000 is honoured. |

Return type

MarketingEnrollmentList

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingSequencesByIdSteps

MarketingStepList GetMarketingSequencesByIdSteps(ctx, id).Execute()

Returns one sequence's steps in send order.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "seq_7b3e5a1c9d024f68b0a3e7c5d9f1a248" // string | ID is the sequence id from the path, as returned by create.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingSequencesByIdSteps(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingSequencesByIdSteps``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingSequencesByIdSteps`: MarketingStepList
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingSequencesByIdSteps`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the sequence id from the path, as returned by create.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingSequencesByIdStepsRequest struct via the builder pattern

Name Type Description Notes

Return type

MarketingStepList

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingSummary

MarketingSummary GetMarketingSummary(ctx).Execute()

Rolls up the caller org's campaigns: how many there are, how many are active, and the summed budget and spend in cents.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingSummary(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingSummary``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingSummary`: MarketingSummary
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingSummary`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingSummaryRequest struct via the builder pattern

Return type

MarketingSummary

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingSuppressions

MarketingSuppressionList GetMarketingSuppressions(ctx).Limit(limit).Execute()

Returns the org's opt-out list, newest first — everyone the send gate will refuse to deliver to.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	limit := int64(100) // int64 | Limit caps the rows returned; 0 means 200 and nothing above 1000 is honoured. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingSuppressions(context.Background()).Limit(limit).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingSuppressions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingSuppressions`: MarketingSuppressionList
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingSuppressions`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingSuppressionsRequest struct via the builder pattern

Name Type Description Notes
limit int64 Limit caps the rows returned; 0 means 200 and nothing above 1000 is honoured.

Return type

MarketingSuppressionList

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingSuppressionsCheck

MarketingSuppressionCheck GetMarketingSuppressionsCheck(ctx).Channel(channel).Address(address).Execute()

Answers whether the org's send gate refuses an address, and which list holds it, by the same check every commercial send asks.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	channel := "channel_example" // string | Channel is the surface the entry opts out of; empty is email. (optional)
	address := "[email protected]" // string | Address is the entry: an address, or \"@example.com\" for a company. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingSuppressionsCheck(context.Background()).Channel(channel).Address(address).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingSuppressionsCheck``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingSuppressionsCheck`: MarketingSuppressionCheck
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingSuppressionsCheck`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingSuppressionsCheckRequest struct via the builder pattern

Name Type Description Notes
channel string Channel is the surface the entry opts out of; empty is email.
address string Address is the entry: an address, or "@example.com" for a company.

Return type

MarketingSuppressionCheck

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMarketingUnsubscribe

MarketingUnsubscribed GetMarketingUnsubscribe(ctx).Org(org).Channel(channel).Address(address).Token(token).Company(company).List(list).Execute()

Is the PUBLIC one-click endpoint (no principal): a recipient clicks the signed link in an email footer.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	org := "acme" // string | Org is the org the link was minted for. (optional)
	channel := "email" // string | Channel is the surface to opt out of. (optional)
	address := "[email protected]" // string | Address is the recipient to opt out. (optional)
	token := "9f2a…" // string | Token is the HMAC over (org, channel, address). It is the ONLY authority here — there is no principal — so it binds the request to one tuple and nothing else. (optional)
	company := true // bool | Company opts out everyone at the address's domain as well, in this org alone: a company's unsubscribe. An address at a free mail provider is a person's and is refused 422. (optional)
	list := "list_example" // string | List is the marketing list a broadcast's link leaves; with it the token is the list's, the address leaves that list alone, and the org's other mail still reaches it. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.GetMarketingUnsubscribe(context.Background()).Org(org).Channel(channel).Address(address).Token(token).Company(company).List(list).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.GetMarketingUnsubscribe``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMarketingUnsubscribe`: MarketingUnsubscribed
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.GetMarketingUnsubscribe`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetMarketingUnsubscribeRequest struct via the builder pattern

Name Type Description Notes
org string Org is the org the link was minted for.
channel string Channel is the surface to opt out of.
address string Address is the recipient to opt out.
token string Token is the HMAC over (org, channel, address). It is the ONLY authority here — there is no principal — so it binds the request to one tuple and nothing else.
company bool Company opts out everyone at the address's domain as well, in this org alone: a company's unsubscribe. An address at a free mail provider is a person's and is refused 422.
list string List is the marketing list a broadcast's link leaves; with it the token is the list's, the address leaves that list alone, and the org's other mail still reaches it.

Return type

MarketingUnsubscribed

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchMarketingBroadcastsById

MarketingBroadcast PatchMarketingBroadcastsById(ctx, id).MarketingBroadcastIn(marketingBroadcastIn).Execute()

Changes the fields the body names on a draft or scheduled broadcast and answers it.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "brd_7a3c1e9b5d2f4068a1c3e5b7" // string | ID is the broadcast to change, from the path; ignored on create.
	marketingBroadcastIn := *openapiclient.NewMarketingBroadcastIn() // MarketingBroadcastIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PatchMarketingBroadcastsById(context.Background(), id).MarketingBroadcastIn(marketingBroadcastIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PatchMarketingBroadcastsById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PatchMarketingBroadcastsById`: MarketingBroadcast
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PatchMarketingBroadcastsById`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the broadcast to change, from the path; ignored on create.

Other Parameters

Other parameters are passed through a pointer to a apiPatchMarketingBroadcastsByIdRequest struct via the builder pattern

Name Type Description Notes

marketingBroadcastIn | MarketingBroadcastIn | |

Return type

MarketingBroadcast

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchMarketingListsById

MarketingList PatchMarketingListsById(ctx, id).MarketingListIn(marketingListIn).Execute()

Changes the fields the body names on one of the org's lists and answers the list.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "newsletter" // string | ID is the list to change, from the path; ignored on create.
	marketingListIn := *openapiclient.NewMarketingListIn() // MarketingListIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PatchMarketingListsById(context.Background(), id).MarketingListIn(marketingListIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PatchMarketingListsById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PatchMarketingListsById`: MarketingList
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PatchMarketingListsById`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the list to change, from the path; ignored on create.

Other Parameters

Other parameters are passed through a pointer to a apiPatchMarketingListsByIdRequest struct via the builder pattern

Name Type Description Notes

marketingListIn | MarketingListIn | |

Return type

MarketingList

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchMarketingListsByIdSubscribersBySid

MarketingSubscriber PatchMarketingListsByIdSubscribersBySid(ctx, id, sid).MarketingSubscriberIn(marketingSubscriberIn).Execute()

Changes the fields the body names on one subscriber and answers the row.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "newsletter" // string | ID is the list, by id or slug, from the path.
	sid := int64(1842) // int64 | SID is the subscriber to change, from the path; ignored on add.
	marketingSubscriberIn := *openapiclient.NewMarketingSubscriberIn() // MarketingSubscriberIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PatchMarketingListsByIdSubscribersBySid(context.Background(), id, sid).MarketingSubscriberIn(marketingSubscriberIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PatchMarketingListsByIdSubscribersBySid``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PatchMarketingListsByIdSubscribersBySid`: MarketingSubscriber
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PatchMarketingListsByIdSubscribersBySid`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the list, by id or slug, from the path.
sid int64 SID is the subscriber to change, from the path; ignored on add.

Other Parameters

Other parameters are passed through a pointer to a apiPatchMarketingListsByIdSubscribersBySidRequest struct via the builder pattern

Name Type Description Notes

marketingSubscriberIn | MarketingSubscriberIn | |

Return type

MarketingSubscriber

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingAudiences

MarketingAudience PostMarketingAudiences(ctx).MarketingAudience(marketingAudience).Execute()

Saves a cohort filter for the caller's org.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingAudience := *openapiclient.NewMarketingAudience() // MarketingAudience | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingAudiences(context.Background()).MarketingAudience(marketingAudience).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingAudiences``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingAudiences`: MarketingAudience
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingAudiences`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingAudiencesRequest struct via the builder pattern

Name Type Description Notes
marketingAudience MarketingAudience

Return type

MarketingAudience

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingBetaActions

MarketingBeta PostMarketingBetaActions(ctx).MarketingBetaActIn(marketingBetaActIn).Execute()

Counts one action of the signed-in caller: a star on a Hanzo repository, verified on GitHub for the login named, or a follow of a founder's link, taken on trust.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingBetaActIn := *openapiclient.NewMarketingBetaActIn() // MarketingBetaActIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingBetaActions(context.Background()).MarketingBetaActIn(marketingBetaActIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingBetaActions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingBetaActions`: MarketingBeta
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingBetaActions`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingBetaActionsRequest struct via the builder pattern

Name Type Description Notes
marketingBetaActIn MarketingBetaActIn

Return type

MarketingBeta

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingBetaInvites

MarketingBetaInvites PostMarketingBetaInvites(ctx).MarketingBetaInviteIn(marketingBetaInviteIn).Execute()

Reserves an invite for each address the limits admit and answers the message the member's mailbox sends for each: subject, text and HTML, the unsubscribe headers, with the member's referral link for that invite and a one-click unsubscribe for that address.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingBetaInviteIn := *openapiclient.NewMarketingBetaInviteIn() // MarketingBetaInviteIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingBetaInvites(context.Background()).MarketingBetaInviteIn(marketingBetaInviteIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingBetaInvites``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingBetaInvites`: MarketingBetaInvites
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingBetaInvites`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingBetaInvitesRequest struct via the builder pattern

Name Type Description Notes
marketingBetaInviteIn MarketingBetaInviteIn

Return type

MarketingBetaInvites

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingBetaInvitesSent

MarketingBetaInviteRows PostMarketingBetaInvitesSent(ctx).MarketingBetaInviteSentIn(marketingBetaInviteSentIn).Execute()

Records what the member's browser did with its reservations: the invites sent, and the ones that failed with the mailbox's reason.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingBetaInviteSentIn := *openapiclient.NewMarketingBetaInviteSentIn() // MarketingBetaInviteSentIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingBetaInvitesSent(context.Background()).MarketingBetaInviteSentIn(marketingBetaInviteSentIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingBetaInvitesSent``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingBetaInvitesSent`: MarketingBetaInviteRows
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingBetaInvitesSent`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingBetaInvitesSentRequest struct via the builder pattern

Name Type Description Notes
marketingBetaInviteSentIn MarketingBetaInviteSentIn

Return type

MarketingBetaInviteRows

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingBetaRequest

MarketingBeta PostMarketingBetaRequest(ctx).MarketingBetaRequest(marketingBetaRequest).Execute()

Adds betas to those the signed-in caller asked for, creating the record when there is none.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingBetaRequest := *openapiclient.NewMarketingBetaRequest() // MarketingBetaRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingBetaRequest(context.Background()).MarketingBetaRequest(marketingBetaRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingBetaRequest``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingBetaRequest`: MarketingBeta
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingBetaRequest`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingBetaRequestRequest struct via the builder pattern

Name Type Description Notes
marketingBetaRequest MarketingBetaRequest

Return type

MarketingBeta

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingBroadcasts

MarketingBroadcast PostMarketingBroadcasts(ctx).MarketingBroadcastIn(marketingBroadcastIn).Execute()

Composes a broadcast to one of the org's lists, or a segment of it, and answers 201 with it.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingBroadcastIn := *openapiclient.NewMarketingBroadcastIn() // MarketingBroadcastIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingBroadcasts(context.Background()).MarketingBroadcastIn(marketingBroadcastIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingBroadcasts``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingBroadcasts`: MarketingBroadcast
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingBroadcasts`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingBroadcastsRequest struct via the builder pattern

Name Type Description Notes
marketingBroadcastIn MarketingBroadcastIn

Return type

MarketingBroadcast

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingBroadcastsByIdCancel

MarketingBroadcast PostMarketingBroadcastsByIdCancel(ctx, id).Execute()

Stops a scheduled or sending broadcast and answers it.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "brd_7a3c1e9b5d2f4068a1c3e5b7" // string | ID is the broadcast's id.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingBroadcastsByIdCancel(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingBroadcastsByIdCancel``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingBroadcastsByIdCancel`: MarketingBroadcast
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingBroadcastsByIdCancel`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the broadcast's id.

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingBroadcastsByIdCancelRequest struct via the builder pattern

Name Type Description Notes

Return type

MarketingBroadcast

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingBroadcastsByIdSend

MarketingBroadcast PostMarketingBroadcastsByIdSend(ctx, id).MarketingSendIn(marketingSendIn).Execute()

Sends a draft or scheduled broadcast now, or schedules it for at, and answers 202 with it.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "brd_7a3c1e9b5d2f4068a1c3e5b7" // string | ID is the broadcast, from the path.
	marketingSendIn := *openapiclient.NewMarketingSendIn() // MarketingSendIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingBroadcastsByIdSend(context.Background(), id).MarketingSendIn(marketingSendIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingBroadcastsByIdSend``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingBroadcastsByIdSend`: MarketingBroadcast
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingBroadcastsByIdSend`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the broadcast, from the path.

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingBroadcastsByIdSendRequest struct via the builder pattern

Name Type Description Notes

marketingSendIn | MarketingSendIn | |

Return type

MarketingBroadcast

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingBroadcastsByIdTest

MarketingTestOut PostMarketingBroadcastsByIdTest(ctx, id).MarketingTestIn(marketingTestIn).Execute()

Sends the broadcast as it stands to up to five addresses, its subject marked [Test], through the same rail and footer the real send takes.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "brd_7a3c1e9b5d2f4068a1c3e5b7" // string | ID is the broadcast, from the path.
	marketingTestIn := *openapiclient.NewMarketingTestIn() // MarketingTestIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingBroadcastsByIdTest(context.Background(), id).MarketingTestIn(marketingTestIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingBroadcastsByIdTest``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingBroadcastsByIdTest`: MarketingTestOut
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingBroadcastsByIdTest`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the broadcast, from the path.

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingBroadcastsByIdTestRequest struct via the builder pattern

Name Type Description Notes

marketingTestIn | MarketingTestIn | |

Return type

MarketingTestOut

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingCalendar

MarketingCalendarPost PostMarketingCalendar(ctx).MarketingCalendarPost(marketingCalendarPost).Execute()

Adds a post to the content calendar.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingCalendarPost := *openapiclient.NewMarketingCalendarPost() // MarketingCalendarPost | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingCalendar(context.Background()).MarketingCalendarPost(marketingCalendarPost).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingCalendar``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingCalendar`: MarketingCalendarPost
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingCalendar`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingCalendarRequest struct via the builder pattern

Name Type Description Notes
marketingCalendarPost MarketingCalendarPost

Return type

MarketingCalendarPost

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingCampaigns

MarketingCampaign PostMarketingCampaigns(ctx).MarketingCampaign(marketingCampaign).Execute()

Registers a campaign in the caller's org.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingCampaign := *openapiclient.NewMarketingCampaign() // MarketingCampaign | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingCampaigns(context.Background()).MarketingCampaign(marketingCampaign).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingCampaigns``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingCampaigns`: MarketingCampaign
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingCampaigns`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingCampaignsRequest struct via the builder pattern

Name Type Description Notes
marketingCampaign MarketingCampaign

Return type

MarketingCampaign

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingCampaignsByIdSchedule

MarketingCampaign PostMarketingCampaignsByIdSchedule(ctx, id).MarketingScheduleInput(marketingScheduleInput).Execute()

Sets a campaign's send time and moves it to "scheduled".

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "camp_9f2a1c7d4e8b0a6f3d2c5b1e7a9f4c60" // string | ID is the campaign id from the path.
	marketingScheduleInput := *openapiclient.NewMarketingScheduleInput() // MarketingScheduleInput | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingCampaignsByIdSchedule(context.Background(), id).MarketingScheduleInput(marketingScheduleInput).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingCampaignsByIdSchedule``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingCampaignsByIdSchedule`: MarketingCampaign
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingCampaignsByIdSchedule`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the campaign id from the path.

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingCampaignsByIdScheduleRequest struct via the builder pattern

Name Type Description Notes

marketingScheduleInput | MarketingScheduleInput | |

Return type

MarketingCampaign

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingImports

MarketingCreated PostMarketingImports(ctx).MarketingImportIn(marketingImportIn).Execute()

Creates an import into one of the org's lists and answers it.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingImportIn := *openapiclient.NewMarketingImportIn() // MarketingImportIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingImports(context.Background()).MarketingImportIn(marketingImportIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingImports``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingImports`: MarketingCreated
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingImports`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingImportsRequest struct via the builder pattern

Name Type Description Notes
marketingImportIn MarketingImportIn

Return type

MarketingCreated

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingImportsByIdCancel

MarketingImport PostMarketingImportsByIdCancel(ctx, id).Execute()

Stops an import that has not finished and answers it.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "imp_4c1e9a7b3d2f0e6a8c1b5d7e" // string | ID is the import's id.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingImportsByIdCancel(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingImportsByIdCancel``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingImportsByIdCancel`: MarketingImport
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingImportsByIdCancel`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the import's id.

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingImportsByIdCancelRequest struct via the builder pattern

Name Type Description Notes

Return type

MarketingImport

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingImportsByIdStart

MarketingImport PostMarketingImportsByIdStart(ctx, id).Execute()

Queues an import whose bytes have all arrived and answers 202 with it; a worker reads it from there.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "imp_4c1e9a7b3d2f0e6a8c1b5d7e" // string | ID is the import's id.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingImportsByIdStart(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingImportsByIdStart``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingImportsByIdStart`: MarketingImport
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingImportsByIdStart`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the import's id.

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingImportsByIdStartRequest struct via the builder pattern

Name Type Description Notes

Return type

MarketingImport

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingLeads

MarketingLead PostMarketingLeads(ctx).MarketingLeadIn(marketingLeadIn).Execute()

Files one public form in the deployment's own CRM.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingLeadIn := *openapiclient.NewMarketingLeadIn() // MarketingLeadIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingLeads(context.Background()).MarketingLeadIn(marketingLeadIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingLeads``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingLeads`: MarketingLead
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingLeads`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingLeadsRequest struct via the builder pattern

Name Type Description Notes
marketingLeadIn MarketingLeadIn

Return type

MarketingLead

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingLeadsEsign

MarketingSigning PostMarketingLeadsEsign(ctx).MarketingEsignEvent(marketingEsignEvent).Execute()

Takes Hanzo eSign's webhook: a SAFE was signed, countersigned, completed, declined or voided, and the investor's form in the brand's CRM moves to that status.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingEsignEvent := *openapiclient.NewMarketingEsignEvent() // MarketingEsignEvent | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingLeadsEsign(context.Background()).MarketingEsignEvent(marketingEsignEvent).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingLeadsEsign``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingLeadsEsign`: MarketingSigning
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingLeadsEsign`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingLeadsEsignRequest struct via the builder pattern

Name Type Description Notes
marketingEsignEvent MarketingEsignEvent

Return type

MarketingSigning

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingLeadsResume

MarketingResumeForm PostMarketingLeadsResume(ctx).MarketingResumeIn(marketingResumeIn).Execute()

Signs a form the careers page posts one resume through, into the brand org's private careers bucket, and answers the key to name on the application (resume_file).

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingResumeIn := *openapiclient.NewMarketingResumeIn() // MarketingResumeIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingLeadsResume(context.Background()).MarketingResumeIn(marketingResumeIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingLeadsResume``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingLeadsResume`: MarketingResumeForm
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingLeadsResume`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingLeadsResumeRequest struct via the builder pattern

Name Type Description Notes
marketingResumeIn MarketingResumeIn

Return type

MarketingResumeForm

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingLists

MarketingList PostMarketingLists(ctx).MarketingListIn(marketingListIn).Execute()

Creates a list in the org and answers 201 with it.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingListIn := *openapiclient.NewMarketingListIn() // MarketingListIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingLists(context.Background()).MarketingListIn(marketingListIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingLists``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingLists`: MarketingList
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingLists`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingListsRequest struct via the builder pattern

Name Type Description Notes
marketingListIn MarketingListIn

Return type

MarketingList

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingListsByIdSegments

MarketingSegment PostMarketingListsByIdSegments(ctx, id).MarketingSegmentIn(marketingSegmentIn).Execute()

Saves a filter over one list as a segment and answers 201 with it and how many subscribers it selects now.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "newsletter" // string | ID is the list, by id or slug, from the path.
	marketingSegmentIn := *openapiclient.NewMarketingSegmentIn() // MarketingSegmentIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingListsByIdSegments(context.Background(), id).MarketingSegmentIn(marketingSegmentIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingListsByIdSegments``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingListsByIdSegments`: MarketingSegment
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingListsByIdSegments`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the list, by id or slug, from the path.

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingListsByIdSegmentsRequest struct via the builder pattern

Name Type Description Notes

marketingSegmentIn | MarketingSegmentIn | |

Return type

MarketingSegment

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingListsByIdSubscribers

MarketingAdded PostMarketingListsByIdSubscribers(ctx, id).MarketingSubscriberIn(marketingSubscriberIn).Execute()

Adds an address to one of the org's lists, or updates it when it is already there, and answers 201 or 200 with the row.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "newsletter" // string | ID is the list, by id or slug, from the path.
	marketingSubscriberIn := *openapiclient.NewMarketingSubscriberIn() // MarketingSubscriberIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingListsByIdSubscribers(context.Background(), id).MarketingSubscriberIn(marketingSubscriberIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingListsByIdSubscribers``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingListsByIdSubscribers`: MarketingAdded
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingListsByIdSubscribers`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the list, by id or slug, from the path.

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingListsByIdSubscribersRequest struct via the builder pattern

Name Type Description Notes

marketingSubscriberIn | MarketingSubscriberIn | |

Return type

MarketingAdded

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingListsByIdSubscribersBulk

MarketingBulkOut PostMarketingListsByIdSubscribersBulk(ctx, id).MarketingBulkIn(marketingBulkIn).Execute()

Applies one action to a selection of a list and answers how many rows it matched and changed.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "newsletter" // string | ID is the list, by id or slug, from the path.
	marketingBulkIn := *openapiclient.NewMarketingBulkIn() // MarketingBulkIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingListsByIdSubscribersBulk(context.Background(), id).MarketingBulkIn(marketingBulkIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingListsByIdSubscribersBulk``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingListsByIdSubscribersBulk`: MarketingBulkOut
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingListsByIdSubscribersBulk`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the list, by id or slug, from the path.

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingListsByIdSubscribersBulkRequest struct via the builder pattern

Name Type Description Notes

marketingBulkIn | MarketingBulkIn | |

Return type

MarketingBulkOut

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingMail

MarketingMailOut PostMarketingMail(ctx).MarketingMailIn(marketingMailIn).Execute()

Sends one email from the org to one person, the way a person on the org's team writes back to a lead from its record.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingMailIn := *openapiclient.NewMarketingMailIn() // MarketingMailIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingMail(context.Background()).MarketingMailIn(marketingMailIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingMail``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingMail`: MarketingMailOut
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingMail`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingMailRequest struct via the builder pattern

Name Type Description Notes
marketingMailIn MarketingMailIn

Return type

MarketingMailOut

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingPromosByCodeRedeem

MarketingRedeemResult PostMarketingPromosByCodeRedeem(ctx, code).MarketingRedeemInput(marketingRedeemInput).Execute()

Records the caller org's claim on a promo.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	code := "first1000" // string | Code is the promo code from the path.
	marketingRedeemInput := *openapiclient.NewMarketingRedeemInput() // MarketingRedeemInput | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingPromosByCodeRedeem(context.Background(), code).MarketingRedeemInput(marketingRedeemInput).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingPromosByCodeRedeem``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingPromosByCodeRedeem`: MarketingRedeemResult
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingPromosByCodeRedeem`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
code string Code is the promo code from the path.

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingPromosByCodeRedeemRequest struct via the builder pattern

Name Type Description Notes

marketingRedeemInput | MarketingRedeemInput | |

Return type

MarketingRedeemResult

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingSequences

MarketingSequence PostMarketingSequences(ctx).MarketingSequence(marketingSequence).Execute()

Registers a drip sequence in the caller's org.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingSequence := *openapiclient.NewMarketingSequence() // MarketingSequence | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingSequences(context.Background()).MarketingSequence(marketingSequence).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingSequences``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingSequences`: MarketingSequence
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingSequences`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingSequencesRequest struct via the builder pattern

Name Type Description Notes
marketingSequence MarketingSequence

Return type

MarketingSequence

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingSequencesByIdEnroll

MarketingEnrollResult PostMarketingSequencesByIdEnroll(ctx, id).MarketingEnrollInput(marketingEnrollInput).Execute()

Adds one contact or a whole audience to a sequence and schedules the first step for each.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "id_example" // string | ID is the sequence id from the path.
	marketingEnrollInput := *openapiclient.NewMarketingEnrollInput() // MarketingEnrollInput | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingSequencesByIdEnroll(context.Background(), id).MarketingEnrollInput(marketingEnrollInput).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingSequencesByIdEnroll``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingSequencesByIdEnroll`: MarketingEnrollResult
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingSequencesByIdEnroll`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the sequence id from the path.

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingSequencesByIdEnrollRequest struct via the builder pattern

Name Type Description Notes

marketingEnrollInput | MarketingEnrollInput | |

Return type

MarketingEnrollResult

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingSequencesByIdEnrollmentsByEidCancel

PostMarketingSequencesByIdEnrollmentsByEidCancel(ctx, id, eid).Execute()

Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "seq_7b3e5a1c9d024f68b0a3e7c5d9f1a248" // string | ID is the sequence id from the path.
	eid := "enr_2a8d6f0b4c1e9375a0d2f6b8c4e19f73" // string | EID is the enrollment id from the path, as returned by a single-address enroll.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.MarketingAPI.PostMarketingSequencesByIdEnrollmentsByEidCancel(context.Background(), id, eid).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingSequencesByIdEnrollmentsByEidCancel``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the sequence id from the path.
eid string EID is the enrollment id from the path, as returned by a single-address enroll.

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingSequencesByIdEnrollmentsByEidCancelRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingSequencesByIdStatus

MarketingSequenceStatus PostMarketingSequencesByIdStatus(ctx, id).MarketingSequenceStatus(marketingSequenceStatus).Execute()

Flips draft/active/archived — the activation gate for sending, since only an active sequence accepts enrollments.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "seq_7b3e5a1c9d024f68b0a3e7c5d9f1a248" // string | ID is the sequence id from the path.
	marketingSequenceStatus := *openapiclient.NewMarketingSequenceStatus() // MarketingSequenceStatus | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingSequencesByIdStatus(context.Background(), id).MarketingSequenceStatus(marketingSequenceStatus).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingSequencesByIdStatus``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingSequencesByIdStatus`: MarketingSequenceStatus
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingSequencesByIdStatus`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the sequence id from the path.

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingSequencesByIdStatusRequest struct via the builder pattern

Name Type Description Notes

marketingSequenceStatus | MarketingSequenceStatus | |

Return type

MarketingSequenceStatus

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingSequencesByIdSteps

MarketingStep PostMarketingSequencesByIdSteps(ctx, id).MarketingStepInput(marketingStepInput).Execute()

Appends a message to the END of a sequence: the new step's idx is one past the last, so steps arrive in the order they are added.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "id_example" // string | SequenceID is the sequence id from the path (the route's :id).
	marketingStepInput := *openapiclient.NewMarketingStepInput() // MarketingStepInput | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingSequencesByIdSteps(context.Background(), id).MarketingStepInput(marketingStepInput).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingSequencesByIdSteps``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingSequencesByIdSteps`: MarketingStep
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingSequencesByIdSteps`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string SequenceID is the sequence id from the path (the route's :id).

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingSequencesByIdStepsRequest struct via the builder pattern

Name Type Description Notes

marketingStepInput | MarketingStepInput | |

Return type

MarketingStep

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingSubscribe

MarketingSubscription PostMarketingSubscribe(ctx).MarketingSubscribeIn(marketingSubscribeIn).Execute()

Asks for the brand's newsletter for an address and answers 202 pending.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingSubscribeIn := *openapiclient.NewMarketingSubscribeIn() // MarketingSubscribeIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingSubscribe(context.Background()).MarketingSubscribeIn(marketingSubscribeIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingSubscribe``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingSubscribe`: MarketingSubscription
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingSubscribe`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingSubscribeRequest struct via the builder pattern

Name Type Description Notes
marketingSubscribeIn MarketingSubscribeIn

Return type

MarketingSubscription

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingSubscribeConfirm

MarketingSubscription PostMarketingSubscribeConfirm(ctx).MarketingConfirmIn(marketingConfirmIn).Execute()

Subscribes the address a confirmation link names and answers 200 confirmed.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingConfirmIn := *openapiclient.NewMarketingConfirmIn() // MarketingConfirmIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingSubscribeConfirm(context.Background()).MarketingConfirmIn(marketingConfirmIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingSubscribeConfirm``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingSubscribeConfirm`: MarketingSubscription
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingSubscribeConfirm`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingSubscribeConfirmRequest struct via the builder pattern

Name Type Description Notes
marketingConfirmIn MarketingConfirmIn

Return type

MarketingSubscription

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingSuppressions

MarketingSuppression PostMarketingSuppressions(ctx).MarketingSuppression(marketingSuppression).Execute()

Records an opt-out for the org (admin / self-service management).

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingSuppression := *openapiclient.NewMarketingSuppression() // MarketingSuppression | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingSuppressions(context.Background()).MarketingSuppression(marketingSuppression).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingSuppressions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingSuppressions`: MarketingSuppression
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingSuppressions`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingSuppressionsRequest struct via the builder pattern

Name Type Description Notes
marketingSuppression MarketingSuppression

Return type

MarketingSuppression

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostMarketingUnsubscribe

MarketingUnsubscribed PostMarketingUnsubscribe(ctx).Org(org).Channel(channel).Address(address).Token(token).List(list).ListUnsubscribe(listUnsubscribe).Execute()

Is the one-click unsubscribe a mail client sends from the List-Unsubscribe header (RFC 8058): the same signed link the footer carries, POSTed with the form body List-Unsubscribe=One-Click.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	org := "acme" // string | Org is the org the link was minted for. (optional)
	channel := "email" // string | Channel is the surface to opt out of. (optional)
	address := "[email protected]" // string | Address is the recipient to opt out. (optional)
	token := "9f2a…" // string | Token is the HMAC over (org, channel, address), the only authority here. (optional)
	list := "list_example" // string | List is the marketing list the link leaves, as on the signed link. (optional)
	listUnsubscribe := "listUnsubscribe_example" // string | OneClick is the form's List-Unsubscribe field, \\\"One-Click\\\" from a mail client. The token decides; this field only names the form. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PostMarketingUnsubscribe(context.Background()).Org(org).Channel(channel).Address(address).Token(token).List(list).ListUnsubscribe(listUnsubscribe).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PostMarketingUnsubscribe``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostMarketingUnsubscribe`: MarketingUnsubscribed
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PostMarketingUnsubscribe`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostMarketingUnsubscribeRequest struct via the builder pattern

Name Type Description Notes
org string Org is the org the link was minted for.
channel string Channel is the surface to opt out of.
address string Address is the recipient to opt out.
token string Token is the HMAC over (org, channel, address), the only authority here.
list string List is the marketing list the link leaves, as on the signed link.
listUnsubscribe string OneClick is the form's List-Unsubscribe field, \"One-Click\" from a mail client. The token decides; this field only names the form.

Return type

MarketingUnsubscribed

Authorization

bearer

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PutMarketingBeta

MarketingBeta PutMarketingBeta(ctx).MarketingBetaIn(marketingBetaIn).Execute()

Writes the signed-in caller's application: the program, the answers, the betas asked for and the lead it was filed under.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingBetaIn := *openapiclient.NewMarketingBetaIn() // MarketingBetaIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PutMarketingBeta(context.Background()).MarketingBetaIn(marketingBetaIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PutMarketingBeta``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PutMarketingBeta`: MarketingBeta
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PutMarketingBeta`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPutMarketingBetaRequest struct via the builder pattern

Name Type Description Notes
marketingBetaIn MarketingBetaIn

Return type

MarketingBeta

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PutMarketingCalendarById

MarketingCalendarPost PutMarketingCalendarById(ctx, id).MarketingCalendarPost(marketingCalendarPost).Execute()

Replaces a post's editable fields.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "id_example" // string | ID is the server-assigned post id (\"cal_\" + 128 random bits).
	marketingCalendarPost := *openapiclient.NewMarketingCalendarPost() // MarketingCalendarPost | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PutMarketingCalendarById(context.Background(), id).MarketingCalendarPost(marketingCalendarPost).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PutMarketingCalendarById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PutMarketingCalendarById`: MarketingCalendarPost
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PutMarketingCalendarById`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the server-assigned post id ("cal_" + 128 random bits).

Other Parameters

Other parameters are passed through a pointer to a apiPutMarketingCalendarByIdRequest struct via the builder pattern

Name Type Description Notes

marketingCalendarPost | MarketingCalendarPost | |

Return type

MarketingCalendarPost

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PutMarketingCampaignsById

MarketingCampaign PutMarketingCampaignsById(ctx, id).MarketingCampaign(marketingCampaign).Execute()

Replaces a campaign's editable fields.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "id_example" // string | ID is the server-assigned campaign id (\"camp_\" + 128 random bits).
	marketingCampaign := *openapiclient.NewMarketingCampaign() // MarketingCampaign | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PutMarketingCampaignsById(context.Background(), id).MarketingCampaign(marketingCampaign).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PutMarketingCampaignsById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PutMarketingCampaignsById`: MarketingCampaign
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PutMarketingCampaignsById`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the server-assigned campaign id ("camp_" + 128 random bits).

Other Parameters

Other parameters are passed through a pointer to a apiPutMarketingCampaignsByIdRequest struct via the builder pattern

Name Type Description Notes

marketingCampaign | MarketingCampaign | |

Return type

MarketingCampaign

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PutMarketingFields

MarketingFieldSet PutMarketingFields(ctx).MarketingFieldSet(marketingFieldSet).Execute()

Replaces the org's custom fields with the set the body carries and answers it.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingFieldSet := *openapiclient.NewMarketingFieldSet() // MarketingFieldSet | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PutMarketingFields(context.Background()).MarketingFieldSet(marketingFieldSet).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PutMarketingFields``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PutMarketingFields`: MarketingFieldSet
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PutMarketingFields`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPutMarketingFieldsRequest struct via the builder pattern

Name Type Description Notes
marketingFieldSet MarketingFieldSet

Return type

MarketingFieldSet

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PutMarketingImportsByIdData

PutMarketingImportsByIdData(ctx, id).Execute()

Takes a piece of an import's file at the offset the query names and answers how many bytes the import now holds.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "id_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.MarketingAPI.PutMarketingImportsByIdData(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PutMarketingImportsByIdData``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Other Parameters

Other parameters are passed through a pointer to a apiPutMarketingImportsByIdDataRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PutMarketingListsByIdSegmentsBySid

MarketingSegment PutMarketingListsByIdSegmentsBySid(ctx, id, sid).MarketingSegmentIn(marketingSegmentIn).Execute()

Replaces a segment's name and filter and answers it with how many subscribers it selects now.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "newsletter" // string | ID is the list, by id or slug, from the path.
	sid := "seg_0b7e3c1a9d2f4e6a8c0b1d3e" // string | SID is the segment to change, from the path; ignored on create.
	marketingSegmentIn := *openapiclient.NewMarketingSegmentIn() // MarketingSegmentIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PutMarketingListsByIdSegmentsBySid(context.Background(), id, sid).MarketingSegmentIn(marketingSegmentIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PutMarketingListsByIdSegmentsBySid``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PutMarketingListsByIdSegmentsBySid`: MarketingSegment
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PutMarketingListsByIdSegmentsBySid`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the list, by id or slug, from the path.
sid string SID is the segment to change, from the path; ignored on create.

Other Parameters

Other parameters are passed through a pointer to a apiPutMarketingListsByIdSegmentsBySidRequest struct via the builder pattern

Name Type Description Notes

marketingSegmentIn | MarketingSegmentIn | |

Return type

MarketingSegment

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PutMarketingSender

MarketingSender PutMarketingSender(ctx).MarketingSender(marketingSender).Execute()

Replaces the org's sender and answers it.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	marketingSender := *openapiclient.NewMarketingSender() // MarketingSender | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MarketingAPI.PutMarketingSender(context.Background()).MarketingSender(marketingSender).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MarketingAPI.PutMarketingSender``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PutMarketingSender`: MarketingSender
	fmt.Fprintf(os.Stdout, "Response from `MarketingAPI.PutMarketingSender`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPutMarketingSenderRequest struct via the builder pattern

Name Type Description Notes
marketingSender MarketingSender

Return type

MarketingSender

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]