Reference for the public Cloudmailer API calls.
Generated packages use semantic versioning since 2.0.0. The endpoints (v1) itself should always be backwards compatible.
The API uses rate limiting based on requests per minute. Every API response contains the following two headers: 'X-RateLimit-Limit', 'X-RateLimit-Remaining'. X-RateLimit-Limit indicates the request limit per minute. X-RateLimit-Remaining indicates the amount of available requests.
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 3.0.0
- Package version: 3.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optionalPut the package under your project folder and add the following in import:
import "./cloudmailer"All URIs are relative to https://app.cloudmailer.nl/api/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AutomationApi | AutomationIndex | Get /automations | Get automations paginated |
| AutomationApi | AutomationInternName | Get /automations/{internName}/name | Show automation using the internal name |
| AutomationApi | AutomationSend | Post /automations/{internName}/send | Send an automation |
| AutomationApi | AutomationTrackId | Get /automations/track/{trackId}/id | Track automation by ID |
| AutomationApi | AutomationTrackRef | Get /automations/track/{trackRef}/ref | Track automation by reference |
| EventApi | EventTriggerGeneric | Post /events/generic/trigger | Trigger a generic event |
| EventApi | EventTriggerOrderCreated | Post /events/order-created/trigger | Trigger the order created event |
| EventApi | EventTriggerOrderPaid | Post /events/order-paid/trigger | Trigger the order paid event |
| FlowApi | FlowConfigTrigger | Post /flow-configs/{id}/trigger | Trigger a specific flow config |
| GroupApi | GroupImportJson | Post /groups/{id}/import | Import JSON into a group |
| GroupApi | GroupIndex | Get /groups | Get groups paginated |
| GroupApi | GroupIndexMember | Get /groups/{id}/members | Get members in group paginated |
| MemberApi | MemberDelete | Delete /members/{id} | Delete a member by ID |
| MemberApi | MemberDeleteEmail | Delete /members/{email}/email | Delete a member by email |
| MemberApi | MemberShow | Get /members/{id} | Get a member by ID |
| MemberApi | MemberShowEmail | Get /members/{email}/email | Get a member by email |
| MemberApi | MemberStoreUnvalidated | Post /members/unvalidated | Subscribe and send validation email |
| MemberApi | MemberStoreValidated | Post /members/validated | Subscribe a member without a validation email |
| MemberApi | MemberUnsubscribe | Post /members/unsubscribe | Unsubscribe a member from a client or groups |
| MemberApi | MemberUpdate | Put /members/{id} | Update a member by ID |
| MemberApi | MemberUpdateEmail | Put /members/{email}/email | Update a member by email |
- AutomationIndexResponse
- AutomationIndexResponseData
- AutomationIndexResponseTemplate
- AutomationSendRequest
- AutomationSendRequestAttachments
- AutomationSendRequestRecipients
- AutomationSendResponse
- AutomationSendResponseData
- AutomationShowNameResponse
- AutomationShowNameResponseData
- AutomationTrackIdResponse
- AutomationTrackIdResponseData
- AutomationTrackIdResponseDataBounces
- AutomationTrackIdResponseDataOpens
- AutomationTrackRefResponse
- DefaultValidationErrorResponse
- EventGenericRequest
- EventOrderRequest
- EventOrderRequestPayload
- EventOrderTrackAndTraceRequest
- EventOrderTrackAndTraceRequestPayload
- EventTriggerResponse
- FlowConfigRequestDynamicGroup
- FlowConfigRequestGroup
- FlowConfigTriggerRequest
- FlowConfigTriggerResponse
- GroupImportRequest
- GroupImportRequestMembers
- GroupImportRequestMetaFields
- GroupIndexResponse
- GroupIndexResponseData
- GroupMemberIndexResponse
- GroupMemberIndexResponseData
- GroupMemberIndexResponseMetaFields
- MemberRequestGroup
- MemberRequestMetaField
- MemberResponse
- MemberResponseData
- MemberStoreRequest
- MemberStoreRequestAutomation
- MemberStoreResponse
- MemberUnsubscribeRequest
- MemberUnsubscribeResponse
- MemberUpdateRequest
- MemberUpdateResponse
- MessageResponse
- ReplacementAddress
- ReplacementCoupon
- ReplacementImage
- ReplacementOrder
- ReplacementOrderLine
- ResponseAutomation
- ResponseAutomationReplacements
- ResponseBounce
- ResponseCampaign
- ResponseClick
- ResponseClient
- ResponseGroup
- ResponseMail
- ResponseMember
- ResponseMetaField
- ResponseOpen
- ResponseRecipient
- ResponseReplacement
- ResponseTemplate
- Type: API key
Example
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)