Skip to content

Latest commit

 

History

History
238 lines (151 loc) · 8.8 KB

TokensApi.md

File metadata and controls

238 lines (151 loc) · 8.8 KB
Raw

\TokensApi

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

Method HTTP request Description
DeleteCrmV3TimelineAppIdEventTemplatesEventTemplateIdTokensTokenNameArchive Delete /crm/v3/timeline/{appId}/event-templates/{eventTemplateId}/tokens/{tokenName} Removes a token from the event template
PostCrmV3TimelineAppIdEventTemplatesEventTemplateIdTokensCreate Post /crm/v3/timeline/{appId}/event-templates/{eventTemplateId}/tokens Adds a token to an existing event template
PutCrmV3TimelineAppIdEventTemplatesEventTemplateIdTokensTokenNameUpdate Put /crm/v3/timeline/{appId}/event-templates/{eventTemplateId}/tokens/{tokenName} Updates an existing token on an event template

DeleteCrmV3TimelineAppIdEventTemplatesEventTemplateIdTokensTokenNameArchive

DeleteCrmV3TimelineAppIdEventTemplatesEventTemplateIdTokensTokenNameArchive(ctx, eventTemplateId, tokenName, appId).Execute()

Removes a token from the event template

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    eventTemplateId := "eventTemplateId_example" // string | The event template ID.
    tokenName := "tokenName_example" // string | The token name.
    appId := int32(56) // int32 | The ID of the target app.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TokensApi.DeleteCrmV3TimelineAppIdEventTemplatesEventTemplateIdTokensTokenNameArchive(context.Background(), eventTemplateId, tokenName, appId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TokensApi.DeleteCrmV3TimelineAppIdEventTemplatesEventTemplateIdTokensTokenNameArchive``: %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.
eventTemplateId string The event template ID.
tokenName string The token name.
appId int32 The ID of the target app.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

developer_hapikey

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

PostCrmV3TimelineAppIdEventTemplatesEventTemplateIdTokensCreate

TimelineEventTemplateToken PostCrmV3TimelineAppIdEventTemplatesEventTemplateIdTokensCreate(ctx, eventTemplateId, appId).TimelineEventTemplateToken(timelineEventTemplateToken).Execute()

Adds a token to an existing event template

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    eventTemplateId := "eventTemplateId_example" // string | The event template ID.
    appId := int32(56) // int32 | The ID of the target app.
    timelineEventTemplateToken := *openapiclient.NewTimelineEventTemplateToken("petType", "Pet Type", "enumeration") // TimelineEventTemplateToken | The new token definition.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventTemplateId string The event template ID.
appId int32 The ID of the target app.

Other Parameters

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

Name Type Description Notes

timelineEventTemplateToken | TimelineEventTemplateToken | The new token definition. |

Return type

TimelineEventTemplateToken

Authorization

developer_hapikey

HTTP request headers

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

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

PutCrmV3TimelineAppIdEventTemplatesEventTemplateIdTokensTokenNameUpdate

TimelineEventTemplateToken PutCrmV3TimelineAppIdEventTemplatesEventTemplateIdTokensTokenNameUpdate(ctx, eventTemplateId, tokenName, appId).TimelineEventTemplateTokenUpdateRequest(timelineEventTemplateTokenUpdateRequest).Execute()

Updates an existing token on an event template

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    eventTemplateId := "eventTemplateId_example" // string | The event template ID.
    tokenName := "tokenName_example" // string | The token name.
    appId := int32(56) // int32 | The ID of the target app.
    timelineEventTemplateTokenUpdateRequest := *openapiclient.NewTimelineEventTemplateTokenUpdateRequest("petType edit") // TimelineEventTemplateTokenUpdateRequest | The updated token definition.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TokensApi.PutCrmV3TimelineAppIdEventTemplatesEventTemplateIdTokensTokenNameUpdate(context.Background(), eventTemplateId, tokenName, appId).TimelineEventTemplateTokenUpdateRequest(timelineEventTemplateTokenUpdateRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TokensApi.PutCrmV3TimelineAppIdEventTemplatesEventTemplateIdTokensTokenNameUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PutCrmV3TimelineAppIdEventTemplatesEventTemplateIdTokensTokenNameUpdate`: TimelineEventTemplateToken
    fmt.Fprintf(os.Stdout, "Response from `TokensApi.PutCrmV3TimelineAppIdEventTemplatesEventTemplateIdTokensTokenNameUpdate`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventTemplateId string The event template ID.
tokenName string The token name.
appId int32 The ID of the target app.

Other Parameters

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

Name Type Description Notes

timelineEventTemplateTokenUpdateRequest | TimelineEventTemplateTokenUpdateRequest | The updated token definition. |

Return type

TimelineEventTemplateToken

Authorization

developer_hapikey

HTTP request headers

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

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