\NotificationsApi

All URIs are relative to https://sailpoint.api.identitynow.com/beta

Method	HTTP request	Description
CreateDomainDkim	Post /verified-domains	Verify domain address via DKIM
CreateNotificationTemplate	Post /notification-templates	Create Notification Template
CreateVerifiedFromAddress	Post /verified-from-addresses	Create Verified From Address
DeleteNotificationTemplatesInBulk	Post /notification-templates/bulk-delete	Bulk Delete Notification Templates
DeleteVerifiedFromAddress	Delete /verified-from-addresses/{id}	Delete Verified From Address
GetDkimAttributes	Get /verified-domains	Get DKIM Attributes
GetMailFromAttributes	Get /mail-from-attributes/{identity}	Get MAIL FROM Attributes
GetNotificationPreference	Get /notification-preferences/{key}	Get Notification Preferences for tenant.
GetNotificationTemplate	Get /notification-templates/{id}	Get Notification Template By Id
GetNotificationsTemplateContext	Get /notification-template-context	Get Notification Template Context
ListFromAddresses	Get /verified-from-addresses	List From Addresses
ListNotificationTemplateDefaults	Get /notification-template-defaults	List Notification Template Defaults
ListNotificationTemplates	Get /notification-templates	List Notification Templates
PutMailFromAttributes	Put /mail-from-attributes	Change MAIL FROM domain
PutNotificationPreference	Put /notification-preferences/{key}	Overwrite the preferences for the given notification key.
SendTestNotification	Post /send-test-notification	Send Test Notification

CreateDomainDkim

DomainStatusDto CreateDomainDkim(ctx).DomainAddress(domainAddress).Execute()

Verify domain address via DKIM

Example

package main

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

func main() {
    domainAddress := *openapiclient.NewDomainAddress() // DomainAddress | 

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
domainAddress	DomainAddress

Return type

DomainStatusDto

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

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

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

CreateNotificationTemplate

TemplateDto CreateNotificationTemplate(ctx).TemplateDto(templateDto).Execute()

Create Notification Template

Example

package main

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

func main() {
    templateDto := *openapiclient.NewTemplateDto("cloud_manual_work_item_summary", "EMAIL", "en") // TemplateDto | 

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
templateDto	TemplateDto

Return type

TemplateDto

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

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

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

CreateVerifiedFromAddress

EmailStatusDto CreateVerifiedFromAddress(ctx).EmailStatusDto(emailStatusDto).Execute()

Create Verified From Address

Example

package main

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

func main() {
    emailStatusDto := *openapiclient.NewEmailStatusDto() // EmailStatusDto | 

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
emailStatusDto	EmailStatusDto

Return type

EmailStatusDto

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

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

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

DeleteNotificationTemplatesInBulk

DeleteNotificationTemplatesInBulk(ctx).TemplateBulkDeleteDto(templateBulkDeleteDto).Execute()

Bulk Delete Notification Templates

Example

package main

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

func main() {
    templateBulkDeleteDto := []openapiclient.TemplateBulkDeleteDto{*openapiclient.NewTemplateBulkDeleteDto("cloud_manual_work_item_summary")} // []TemplateBulkDeleteDto | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.NotificationsApi.DeleteNotificationTemplatesInBulk(context.Background()).TemplateBulkDeleteDto(templateBulkDeleteDto).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NotificationsApi.DeleteNotificationTemplatesInBulk``: %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 apiDeleteNotificationTemplatesInBulkRequest struct via the builder pattern

Name	Type	Description	Notes
templateBulkDeleteDto	[]TemplateBulkDeleteDto

Return type

(empty response body)

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

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

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

DeleteVerifiedFromAddress

DeleteVerifiedFromAddress(ctx, id).Execute()

Delete Verified From Address

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.NotificationsApi.DeleteVerifiedFromAddress(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NotificationsApi.DeleteVerifiedFromAddress``: %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 apiDeleteVerifiedFromAddressRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetDkimAttributes

[]DkimAttributes GetDkimAttributes(ctx).Execute()

Get DKIM Attributes

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]DkimAttributes

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetMailFromAttributes

MailFromAttributes GetMailFromAttributes(ctx).Id(id).Execute()

Get MAIL FROM Attributes

Example

package main

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

func main() {
    id := "bobsmith@sailpoint.com" // string | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
id	string	Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status

Return type

MailFromAttributes

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetNotificationPreference

PreferencesDto GetNotificationPreference(ctx, key).Execute()

Get Notification Preferences for tenant.

Example

package main

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

func main() {
    key := "key_example" // string | The notification key.

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

PreferencesDto

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetNotificationTemplate

[]TemplateDto GetNotificationTemplate(ctx, id).Execute()

Get Notification Template By Id

Example

package main

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

func main() {
    id := "c17bea3a-574d-453c-9e04-4365fbf5af0b" // string | Id of the Notification Template

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	Id of the Notification Template

Other Parameters

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

Name	Type	Description	Notes

Return type

[]TemplateDto

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetNotificationsTemplateContext

[]NotificationTemplateContext GetNotificationsTemplateContext(ctx).Execute()

Get Notification Template Context

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]NotificationTemplateContext

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ListFromAddresses

[]EmailStatusDto ListFromAddresses(ctx).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute()

List From Addresses

Example

package main

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

func main() {
    limit := int32(250) // int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
    offset := int32(0) // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
    count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false)
    filters := "email eq "john.doe@company.com"" // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **email**: *eq, co, ge, le, sw* (optional)
    sorters := "email" // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **email** (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.NotificationsApi.ListFromAddresses(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NotificationsApi.ListFromAddresses``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListFromAddresses`: []EmailStatusDto
    fmt.Fprintf(os.Stdout, "Response from `NotificationsApi.ListFromAddresses`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
limit	int32	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[default to 250]
offset	int32	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[default to 0]
count	bool	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[default to false]
filters	string	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: email: eq, co, ge, le, sw
sorters	string	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: email

Return type

[]EmailStatusDto

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ListNotificationTemplateDefaults

[]TemplateDtoDefault ListNotificationTemplateDefaults(ctx).Limit(limit).Offset(offset).Filters(filters).Execute()

List Notification Template Defaults

Example

package main

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

func main() {
    limit := int32(250) // int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
    offset := int32(0) // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
    filters := "filters_example" // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **key**: *eq, in, co, sw*  **medium**: *eq, co, sw*  **locale**: *eq, co, sw* (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.NotificationsApi.ListNotificationTemplateDefaults(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NotificationsApi.ListNotificationTemplateDefaults``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListNotificationTemplateDefaults`: []TemplateDtoDefault
    fmt.Fprintf(os.Stdout, "Response from `NotificationsApi.ListNotificationTemplateDefaults`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
limit	int32	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[default to 250]
offset	int32	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[default to 0]
filters	string	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: key: eq, in, co, sw medium: eq, co, sw locale: eq, co, sw

Return type

[]TemplateDtoDefault

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ListNotificationTemplates

[]TemplateDto ListNotificationTemplates(ctx).Limit(limit).Offset(offset).Filters(filters).Execute()

List Notification Templates

Example

package main

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

func main() {
    limit := int32(250) // int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
    offset := int32(0) // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
    filters := "medium eq "EMAIL"" // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **key**: *eq, in, co, sw*  **medium**: *eq, co, sw*  **locale**: *eq, co, sw* (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.NotificationsApi.ListNotificationTemplates(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NotificationsApi.ListNotificationTemplates``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListNotificationTemplates`: []TemplateDto
    fmt.Fprintf(os.Stdout, "Response from `NotificationsApi.ListNotificationTemplates`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
limit	int32	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[default to 250]
offset	int32	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[default to 0]
filters	string	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: key: eq, in, co, sw medium: eq, co, sw locale: eq, co, sw

Return type

[]TemplateDto

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

PutMailFromAttributes

MailFromAttributes PutMailFromAttributes(ctx).MailFromAttributesDto(mailFromAttributesDto).Execute()

Change MAIL FROM domain

Example

package main

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

func main() {
    mailFromAttributesDto := *openapiclient.NewMailFromAttributesDto() // MailFromAttributesDto | 

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
mailFromAttributesDto	MailFromAttributesDto

Return type

MailFromAttributes

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

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

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

PutNotificationPreference

PreferencesDto PutNotificationPreference(ctx, key).PreferencesDto(preferencesDto).Execute()

Overwrite the preferences for the given notification key.

Example

package main

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

func main() {
    key := "key_example" // string | The notification key.
    preferencesDto := *openapiclient.NewPreferencesDto() // PreferencesDto | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

preferencesDto | PreferencesDto | |

Return type

PreferencesDto

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

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

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

SendTestNotification

SendTestNotification(ctx).SendTestNotificationRequestDto(sendTestNotificationRequestDto).Execute()

Send Test Notification

Example

package main

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

func main() {
    sendTestNotificationRequestDto := *openapiclient.NewSendTestNotificationRequestDto() // SendTestNotificationRequestDto | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.NotificationsApi.SendTestNotification(context.Background()).SendTestNotificationRequestDto(sendTestNotificationRequestDto).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NotificationsApi.SendTestNotification``: %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 apiSendTestNotificationRequest struct via the builder pattern

Name	Type	Description	Notes
sendTestNotificationRequestDto	SendTestNotificationRequestDto

Return type

(empty response body)

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

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

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

Files

NotificationsApi.md

Latest commit

History

NotificationsApi.md

File metadata and controls

\NotificationsApi

CreateDomainDkim

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateNotificationTemplate

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateVerifiedFromAddress

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteNotificationTemplatesInBulk

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteVerifiedFromAddress

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetDkimAttributes

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetMailFromAttributes

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetNotificationPreference

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetNotificationTemplate

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetNotificationsTemplateContext

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListFromAddresses

Example

Path Parameters