\DestinationsAPI

All URIs are relative to https://api.segmentapis.com

Method	HTTP request	Description
CreateDestination	Post /destinations	Create Destination
CreateDestinationSubscription	Post /destinations/{destinationId}/subscriptions	Create Destination Subscription
DeleteDestination	Delete /destinations/{destinationId}	Delete Destination
GetDestination	Get /destinations/{destinationId}	Get Destination
GetSubscriptionFromDestination	Get /destinations/{destinationId}/subscriptions/{id}	Get Subscription from Destination
ListDeliveryMetricsSummaryFromDestination	Get /destinations/{destinationId}/delivery-metrics	List Delivery Metrics Summary from Destination
ListDestinations	Get /destinations	List Destinations
ListSubscriptionsFromDestination	Get /destinations/{destinationId}/subscriptions	List Subscriptions from Destination
RemoveSubscriptionFromDestination	Delete /destinations/{destinationId}/subscriptions/{id}	Remove Subscription from Destination
UpdateDestination	Patch /destinations/{destinationId}	Update Destination
UpdateSubscriptionForDestination	Patch /destinations/{destinationId}/subscriptions/{id}	Update Subscription for Destination

Operation: CreateDestination

CreateDestination200Response CreateDestination(ctx).CreateDestinationV1Input(createDestinationV1Input).Execute()

Create Destination

Example

package main

import (
    "context"
    "fmt"
    "os"
    api "github.com/segmentio/public-api-sdk-go"
)

func main() {
    createDestinationV1Input := *api.NewCreateDestinationV1Input("SourceId_example", "MetadataId_example", map[string]interface{}{"key": interface{}(123)}) // CreateDestinationV1Input | 

    configuration := api.NewConfiguration()
    apiClient := api.NewAPIClient(configuration)
    token := "<BEARER_TOKEN>"
    ctx := context.WithValue(context.Background(), api.ContextAccessToken, token)
    resp, r, err := apiClient.DestinationsAPI.CreateDestination(ctx).CreateDestinationV1Input(createDestinationV1Input).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DestinationsAPI.CreateDestination``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
        responseErrors := api.UnwrapFullErrors(err)
        if responseErrors != nil {
            for _, responseError := range responseErrors.Errors {
                fmt.Fprintf(os.Stderr, "Full error message: %v\n", *responseError.Message)
            }
        }
    }
    // response from `CreateDestination`: CreateDestination200Response
    fmt.Fprintf(os.Stdout, "Response from `DestinationsAPI.CreateDestination`: %v\n", resp.GetData())
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
createDestinationV1Input	CreateDestinationV1Input

Return type

CreateDestination200Response

Authorization

token

HTTP request headers

Content-Type: application/json, application/vnd.segment.v1+json, application/vnd.segment.v1beta+json, application/vnd.segment.v1alpha+json
Accept: application/vnd.segment.v1+json, application/json, application/vnd.segment.v1beta+json, application/vnd.segment.v1alpha+json

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

Operation: CreateDestinationSubscription

CreateDestinationSubscription200Response CreateDestinationSubscription(ctx, destinationId).CreateDestinationSubscriptionAlphaInput(createDestinationSubscriptionAlphaInput).Execute()

Create Destination Subscription

Example

package main

import (
    "context"
    "fmt"
    "os"
    api "github.com/segmentio/public-api-sdk-go"
)

func main() {
    destinationId := "fP7qoQw2HTWt9WdMr718gn" // string | 
    createDestinationSubscriptionAlphaInput := *api.NewCreateDestinationSubscriptionAlphaInput("Name_example", "ActionId_example", "Trigger_example", false) // CreateDestinationSubscriptionAlphaInput | 

    configuration := api.NewConfiguration()
    apiClient := api.NewAPIClient(configuration)
    token := "<BEARER_TOKEN>"
    ctx := context.WithValue(context.Background(), api.ContextAccessToken, token)
    resp, r, err := apiClient.DestinationsAPI.CreateDestinationSubscription(ctx, destinationId).CreateDestinationSubscriptionAlphaInput(createDestinationSubscriptionAlphaInput).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DestinationsAPI.CreateDestinationSubscription``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
        responseErrors := api.UnwrapFullErrors(err)
        if responseErrors != nil {
            for _, responseError := range responseErrors.Errors {
                fmt.Fprintf(os.Stderr, "Full error message: %v\n", *responseError.Message)
            }
        }
    }
    // response from `CreateDestinationSubscription`: CreateDestinationSubscription200Response
    fmt.Fprintf(os.Stdout, "Response from `DestinationsAPI.CreateDestinationSubscription`: %v\n", resp.GetData())
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

createDestinationSubscriptionAlphaInput | CreateDestinationSubscriptionAlphaInput | |

Return type

CreateDestinationSubscription200Response

Authorization

token

HTTP request headers

Content-Type: application/vnd.segment.v1alpha+json
Accept: application/vnd.segment.v1alpha+json, application/json

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

Operation: DeleteDestination

DeleteDestination200Response DeleteDestination(ctx, destinationId).Execute()

Delete Destination

Example

package main

import (
    "context"
    "fmt"
    "os"
    api "github.com/segmentio/public-api-sdk-go"
)

func main() {
    destinationId := "65c2bdbede6f2d8297f943db" // string | 

    configuration := api.NewConfiguration()
    apiClient := api.NewAPIClient(configuration)
    token := "<BEARER_TOKEN>"
    ctx := context.WithValue(context.Background(), api.ContextAccessToken, token)
    resp, r, err := apiClient.DestinationsAPI.DeleteDestination(ctx, destinationId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DestinationsAPI.DeleteDestination``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
        responseErrors := api.UnwrapFullErrors(err)
        if responseErrors != nil {
            for _, responseError := range responseErrors.Errors {
                fmt.Fprintf(os.Stderr, "Full error message: %v\n", *responseError.Message)
            }
        }
    }
    // response from `DeleteDestination`: DeleteDestination200Response
    fmt.Fprintf(os.Stdout, "Response from `DestinationsAPI.DeleteDestination`: %v\n", resp.GetData())
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

DeleteDestination200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.segment.v1+json, application/json, application/vnd.segment.v1beta+json, application/vnd.segment.v1alpha+json

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

Operation: GetDestination

GetDestination200Response GetDestination(ctx, destinationId).Execute()

Get Destination

Example

package main

import (
    "context"
    "fmt"
    "os"
    api "github.com/segmentio/public-api-sdk-go"
)

func main() {
    destinationId := "qtiZHLLqqsHmpvLXNtP5du" // string | 

    configuration := api.NewConfiguration()
    apiClient := api.NewAPIClient(configuration)
    token := "<BEARER_TOKEN>"
    ctx := context.WithValue(context.Background(), api.ContextAccessToken, token)
    resp, r, err := apiClient.DestinationsAPI.GetDestination(ctx, destinationId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DestinationsAPI.GetDestination``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
        responseErrors := api.UnwrapFullErrors(err)
        if responseErrors != nil {
            for _, responseError := range responseErrors.Errors {
                fmt.Fprintf(os.Stderr, "Full error message: %v\n", *responseError.Message)
            }
        }
    }
    // response from `GetDestination`: GetDestination200Response
    fmt.Fprintf(os.Stdout, "Response from `DestinationsAPI.GetDestination`: %v\n", resp.GetData())
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

GetDestination200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.segment.v1+json, application/json, application/vnd.segment.v1beta+json, application/vnd.segment.v1alpha+json

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

Operation: GetSubscriptionFromDestination

GetSubscriptionFromDestination200Response GetSubscriptionFromDestination(ctx, destinationId, id).Execute()

Get Subscription from Destination

Example

package main

import (
    "context"
    "fmt"
    "os"
    api "github.com/segmentio/public-api-sdk-go"
)

func main() {
    destinationId := "fP7qoQw2HTWt9WdMr718gn" // string | 
    id := "kyMKN6LUgMvF8dwRMEz3cX" // string | 

    configuration := api.NewConfiguration()
    apiClient := api.NewAPIClient(configuration)
    token := "<BEARER_TOKEN>"
    ctx := context.WithValue(context.Background(), api.ContextAccessToken, token)
    resp, r, err := apiClient.DestinationsAPI.GetSubscriptionFromDestination(ctx, destinationId, id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DestinationsAPI.GetSubscriptionFromDestination``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
        responseErrors := api.UnwrapFullErrors(err)
        if responseErrors != nil {
            for _, responseError := range responseErrors.Errors {
                fmt.Fprintf(os.Stderr, "Full error message: %v\n", *responseError.Message)
            }
        }
    }
    // response from `GetSubscriptionFromDestination`: GetSubscriptionFromDestination200Response
    fmt.Fprintf(os.Stdout, "Response from `DestinationsAPI.GetSubscriptionFromDestination`: %v\n", resp.GetData())
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

GetSubscriptionFromDestination200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.segment.v1alpha+json, application/json

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

Operation: ListDeliveryMetricsSummaryFromDestination

ListDeliveryMetricsSummaryFromDestination200Response ListDeliveryMetricsSummaryFromDestination(ctx, destinationId).SourceId(sourceId).StartTime(startTime).EndTime(endTime).Granularity(granularity).Execute()

List Delivery Metrics Summary from Destination

Example

package main

import (
    "context"
    "fmt"
    "os"
    api "github.com/segmentio/public-api-sdk-go"
)

func main() {
    destinationId := "fP7qoQw2HTWt9WdMr718gn" // string | 
    sourceId := "rh5BDZp6QDHvXFCkibm1pR" // string | The id of the Source linked to the Destination.  Config API note: analogous to `parent`.  This parameter exists in beta.
    startTime := "2006-01-02T15:04:05.000Z" // string | Filter events that happened after this time.  Defaults to: - 1 hour ago if granularity is `MINUTE`. - 7 days ago if granularity is `HOUR`. - 30 days ago if granularity is `DAY`.  This parameter exists in beta. (optional)
    endTime := "2006-01-02T15:04:05.000Z" // string | Filter events that happened before this time. Defaults to now if not set.  This parameter exists in beta. (optional)
    granularity := "DAY" // string | The granularity to filter metrics to. Either `MINUTE`, `HOUR` or `DAY`.  Defaults to `MINUTE` if not set.  This parameter exists in beta. (optional)

    configuration := api.NewConfiguration()
    apiClient := api.NewAPIClient(configuration)
    token := "<BEARER_TOKEN>"
    ctx := context.WithValue(context.Background(), api.ContextAccessToken, token)
    resp, r, err := apiClient.DestinationsAPI.ListDeliveryMetricsSummaryFromDestination(ctx, destinationId).SourceId(sourceId).StartTime(startTime).EndTime(endTime).Granularity(granularity).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DestinationsAPI.ListDeliveryMetricsSummaryFromDestination``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
        responseErrors := api.UnwrapFullErrors(err)
        if responseErrors != nil {
            for _, responseError := range responseErrors.Errors {
                fmt.Fprintf(os.Stderr, "Full error message: %v\n", *responseError.Message)
            }
        }
    }
    // response from `ListDeliveryMetricsSummaryFromDestination`: ListDeliveryMetricsSummaryFromDestination200Response
    fmt.Fprintf(os.Stdout, "Response from `DestinationsAPI.ListDeliveryMetricsSummaryFromDestination`: %v\n", resp.GetData())
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

sourceId | string | The id of the Source linked to the Destination. Config API note: analogous to `parent`. This parameter exists in beta. | startTime | string | Filter events that happened after this time. Defaults to: - 1 hour ago if granularity is `MINUTE`. - 7 days ago if granularity is `HOUR`. - 30 days ago if granularity is `DAY`. This parameter exists in beta. | endTime | string | Filter events that happened before this time. Defaults to now if not set. This parameter exists in beta. | granularity | string | The granularity to filter metrics to. Either `MINUTE`, `HOUR` or `DAY`. Defaults to `MINUTE` if not set. This parameter exists in beta. |

Return type

ListDeliveryMetricsSummaryFromDestination200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.segment.v1beta+json, application/vnd.segment.v1alpha+json, application/json

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

Operation: ListDestinations

ListDestinations200Response ListDestinations(ctx).Pagination(pagination).Execute()

List Destinations

Example

package main

import (
    "context"
    "fmt"
    "os"
    api "github.com/segmentio/public-api-sdk-go"
)

func main() {
    pagination := *api.NewPaginationInput(10) // PaginationInput | Required pagination params for the request.  This parameter exists in v1. (optional)

    configuration := api.NewConfiguration()
    apiClient := api.NewAPIClient(configuration)
    token := "<BEARER_TOKEN>"
    ctx := context.WithValue(context.Background(), api.ContextAccessToken, token)
    resp, r, err := apiClient.DestinationsAPI.ListDestinations(ctx).Pagination(pagination).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DestinationsAPI.ListDestinations``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
        responseErrors := api.UnwrapFullErrors(err)
        if responseErrors != nil {
            for _, responseError := range responseErrors.Errors {
                fmt.Fprintf(os.Stderr, "Full error message: %v\n", *responseError.Message)
            }
        }
    }
    // response from `ListDestinations`: ListDestinations200Response
    fmt.Fprintf(os.Stdout, "Response from `DestinationsAPI.ListDestinations`: %v\n", resp.GetData())
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
pagination	PaginationInput	Required pagination params for the request. This parameter exists in v1.

Return type

ListDestinations200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.segment.v1+json, application/json, application/vnd.segment.v1beta+json, application/vnd.segment.v1alpha+json

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

Operation: ListSubscriptionsFromDestination

ListSubscriptionsFromDestination200Response ListSubscriptionsFromDestination(ctx, destinationId).Pagination(pagination).Execute()

List Subscriptions from Destination

Example

package main

import (
    "context"
    "fmt"
    "os"
    api "github.com/segmentio/public-api-sdk-go"
)

func main() {
    destinationId := "fP7qoQw2HTWt9WdMr718gn" // string | 
    pagination := *api.NewPaginationInput(10) // PaginationInput | Pagination options.  This parameter exists in alpha. (optional)

    configuration := api.NewConfiguration()
    apiClient := api.NewAPIClient(configuration)
    token := "<BEARER_TOKEN>"
    ctx := context.WithValue(context.Background(), api.ContextAccessToken, token)
    resp, r, err := apiClient.DestinationsAPI.ListSubscriptionsFromDestination(ctx, destinationId).Pagination(pagination).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DestinationsAPI.ListSubscriptionsFromDestination``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
        responseErrors := api.UnwrapFullErrors(err)
        if responseErrors != nil {
            for _, responseError := range responseErrors.Errors {
                fmt.Fprintf(os.Stderr, "Full error message: %v\n", *responseError.Message)
            }
        }
    }
    // response from `ListSubscriptionsFromDestination`: ListSubscriptionsFromDestination200Response
    fmt.Fprintf(os.Stdout, "Response from `DestinationsAPI.ListSubscriptionsFromDestination`: %v\n", resp.GetData())
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

pagination | PaginationInput | Pagination options. This parameter exists in alpha. |

Return type

ListSubscriptionsFromDestination200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.segment.v1alpha+json, application/json

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

Operation: RemoveSubscriptionFromDestination

RemoveSubscriptionFromDestination200Response RemoveSubscriptionFromDestination(ctx, destinationId, id).Execute()

Remove Subscription from Destination

Example

package main

import (
    "context"
    "fmt"
    "os"
    api "github.com/segmentio/public-api-sdk-go"
)

func main() {
    destinationId := "fP7qoQw2HTWt9WdMr718gn" // string | 
    id := "zXCqmEMHJojkD45GcBAPt" // string | 

    configuration := api.NewConfiguration()
    apiClient := api.NewAPIClient(configuration)
    token := "<BEARER_TOKEN>"
    ctx := context.WithValue(context.Background(), api.ContextAccessToken, token)
    resp, r, err := apiClient.DestinationsAPI.RemoveSubscriptionFromDestination(ctx, destinationId, id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DestinationsAPI.RemoveSubscriptionFromDestination``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
        responseErrors := api.UnwrapFullErrors(err)
        if responseErrors != nil {
            for _, responseError := range responseErrors.Errors {
                fmt.Fprintf(os.Stderr, "Full error message: %v\n", *responseError.Message)
            }
        }
    }
    // response from `RemoveSubscriptionFromDestination`: RemoveSubscriptionFromDestination200Response
    fmt.Fprintf(os.Stdout, "Response from `DestinationsAPI.RemoveSubscriptionFromDestination`: %v\n", resp.GetData())
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

RemoveSubscriptionFromDestination200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.segment.v1alpha+json, application/json

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

Operation: UpdateDestination

UpdateDestination200Response UpdateDestination(ctx, destinationId).UpdateDestinationV1Input(updateDestinationV1Input).Execute()

Update Destination

Example

package main

import (
    "context"
    "fmt"
    "os"
    api "github.com/segmentio/public-api-sdk-go"
)

func main() {
    destinationId := "qtiZHLLqqsHmpvLXNtP5du" // string | 
    updateDestinationV1Input := *api.NewUpdateDestinationV1Input() // UpdateDestinationV1Input | 

    configuration := api.NewConfiguration()
    apiClient := api.NewAPIClient(configuration)
    token := "<BEARER_TOKEN>"
    ctx := context.WithValue(context.Background(), api.ContextAccessToken, token)
    resp, r, err := apiClient.DestinationsAPI.UpdateDestination(ctx, destinationId).UpdateDestinationV1Input(updateDestinationV1Input).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DestinationsAPI.UpdateDestination``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
        responseErrors := api.UnwrapFullErrors(err)
        if responseErrors != nil {
            for _, responseError := range responseErrors.Errors {
                fmt.Fprintf(os.Stderr, "Full error message: %v\n", *responseError.Message)
            }
        }
    }
    // response from `UpdateDestination`: UpdateDestination200Response
    fmt.Fprintf(os.Stdout, "Response from `DestinationsAPI.UpdateDestination`: %v\n", resp.GetData())
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

updateDestinationV1Input | UpdateDestinationV1Input | |

Return type

UpdateDestination200Response

Authorization

token

HTTP request headers

Content-Type: application/json, application/vnd.segment.v1+json, application/vnd.segment.v1beta+json, application/vnd.segment.v1alpha+json
Accept: application/vnd.segment.v1+json, application/json, application/vnd.segment.v1beta+json, application/vnd.segment.v1alpha+json

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

Operation: UpdateSubscriptionForDestination

UpdateSubscriptionForDestination200Response UpdateSubscriptionForDestination(ctx, destinationId, id).UpdateSubscriptionForDestinationAlphaInput(updateSubscriptionForDestinationAlphaInput).Execute()

Update Subscription for Destination

Example

package main

import (
    "context"
    "fmt"
    "os"
    api "github.com/segmentio/public-api-sdk-go"
)

func main() {
    destinationId := "qtiZHLLqqsHmpvLXNtP5du" // string | 
    id := "pJtn52LjrcD1TrQcm2ZSwp" // string | 
    updateSubscriptionForDestinationAlphaInput := *api.NewUpdateSubscriptionForDestinationAlphaInput(*api.NewDestinationSubscriptionUpdateInput()) // UpdateSubscriptionForDestinationAlphaInput | 

    configuration := api.NewConfiguration()
    apiClient := api.NewAPIClient(configuration)
    token := "<BEARER_TOKEN>"
    ctx := context.WithValue(context.Background(), api.ContextAccessToken, token)
    resp, r, err := apiClient.DestinationsAPI.UpdateSubscriptionForDestination(ctx, destinationId, id).UpdateSubscriptionForDestinationAlphaInput(updateSubscriptionForDestinationAlphaInput).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DestinationsAPI.UpdateSubscriptionForDestination``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
        responseErrors := api.UnwrapFullErrors(err)
        if responseErrors != nil {
            for _, responseError := range responseErrors.Errors {
                fmt.Fprintf(os.Stderr, "Full error message: %v\n", *responseError.Message)
            }
        }
    }
    // response from `UpdateSubscriptionForDestination`: UpdateSubscriptionForDestination200Response
    fmt.Fprintf(os.Stdout, "Response from `DestinationsAPI.UpdateSubscriptionForDestination`: %v\n", resp.GetData())
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

updateSubscriptionForDestinationAlphaInput | UpdateSubscriptionForDestinationAlphaInput | |

Return type

UpdateSubscriptionForDestination200Response

Authorization

token

HTTP request headers

Content-Type: application/vnd.segment.v1alpha+json
Accept: application/vnd.segment.v1alpha+json, application/json

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

Files

DestinationsAPI.md

Latest commit

History

DestinationsAPI.md

File metadata and controls

\DestinationsAPI

Operation: CreateDestination

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Operation: CreateDestinationSubscription

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Operation: DeleteDestination

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Operation: GetDestination

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Operation: GetSubscriptionFromDestination

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Operation: ListDeliveryMetricsSummaryFromDestination

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Operation: ListDestinations

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Operation: ListSubscriptionsFromDestination

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Operation: RemoveSubscriptionFromDestination

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Operation: UpdateDestination

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Operation: UpdateSubscriptionForDestination

Example

Path Parameters