Subscribers

(Subscribers)

Overview

Available Operations

List - Get subscribers
Create - Create subscriber
Get - Get subscriber
Update - Update subscriber
~~DeleteLegacy~~ - Delete subscriber ⚠️ Deprecated
CreateBulk - Bulk create subscribers
Search - Search for subscribers
Retrieve - Get subscriber
Patch - Patch subscriber
Delete - Delete subscriber
UpdateOnlineStatus - Update subscriber online status

List

Returns a list of subscribers, could paginated using the page and limit query parameter

Example Usage

package main

import(
	"context"
	"os"
	novugo "github.com/novuhq/novu-go"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := novugo.New(
        novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")),
    )

    res, err := s.Subscribers.List(ctx, nil, nil, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`page`	*float64	➖	N/A
`limit`	*float64	➖	N/A
`idempotencyKey`	*string	➖	A header for idempotency purposes
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.SubscribersV1ControllerListSubscribersResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.ErrorDto	414	application/json
apierrors.ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
apierrors.ValidationErrorDto	422	application/json
apierrors.ErrorDto	500	application/json
apierrors.APIError	4XX, 5XX	/

Create

Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity.

Example Usage

package main

import(
	"context"
	"os"
	novugo "github.com/novuhq/novu-go"
	"github.com/novuhq/novu-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := novugo.New(
        novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")),
    )

    res, err := s.Subscribers.Create(ctx, components.CreateSubscriberRequestDto{
        SubscriberID: "<id>",
    }, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.SubscriberResponseDto != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`createSubscriberRequestDto`	components.CreateSubscriberRequestDto	✔️	N/A
`idempotencyKey`	*string	➖	A header for idempotency purposes
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.SubscribersV1ControllerCreateSubscriberResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.ErrorDto	414	application/json
apierrors.ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
apierrors.ValidationErrorDto	422	application/json
apierrors.ErrorDto	500	application/json
apierrors.APIError	4XX, 5XX	/

Get

Get subscriber by your internal id used to identify the subscriber

Example Usage

package main

import(
	"context"
	"os"
	novugo "github.com/novuhq/novu-go"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := novugo.New(
        novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")),
    )

    res, err := s.Subscribers.Get(ctx, "<id>", nil, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.SubscriberResponseDto != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`subscriberID`	string	✔️	N/A
`includeTopics`	*bool	➖	Includes the topics associated with the subscriber
`idempotencyKey`	*string	➖	A header for idempotency purposes
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.SubscribersV1ControllerGetSubscriberResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.ErrorDto	414	application/json
apierrors.ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
apierrors.ValidationErrorDto	422	application/json
apierrors.ErrorDto	500	application/json
apierrors.APIError	4XX, 5XX	/

Update

Used to update the subscriber entity with new information

Example Usage

package main

import(
	"context"
	"os"
	novugo "github.com/novuhq/novu-go"
	"github.com/novuhq/novu-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := novugo.New(
        novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")),
    )

    res, err := s.Subscribers.Update(ctx, "<id>", components.UpdateSubscriberRequestDto{
        Email: novugo.String("john.doe@example.com"),
        FirstName: novugo.String("John"),
        LastName: novugo.String("Doe"),
        Phone: novugo.String("+1234567890"),
        Avatar: novugo.String("https://example.com/avatar.jpg"),
        Locale: novugo.String("en-US"),
        Data: map[string]any{
            "preferences": map[string]any{
                "notifications": true,
                "theme": "dark",
            },
            "tags": []any{
                "premium",
                "newsletter",
            },
        },
    }, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.SubscriberResponseDto != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`subscriberID`	string	✔️	N/A
`updateSubscriberRequestDto`	components.UpdateSubscriberRequestDto	✔️	N/A
`idempotencyKey`	*string	➖	A header for idempotency purposes
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.SubscribersV1ControllerUpdateSubscriberResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.ErrorDto	414	application/json
apierrors.ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
apierrors.ValidationErrorDto	422	application/json
apierrors.ErrorDto	500	application/json
apierrors.APIError	4XX, 5XX	/

DeleteLegacy

Deletes a subscriber entity from the Novu platform

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

package main

import(
	"context"
	"os"
	novugo "github.com/novuhq/novu-go"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := novugo.New(
        novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")),
    )

    res, err := s.Subscribers.DeleteLegacy(ctx, "<id>", nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.DeleteSubscriberResponseDto != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`subscriberID`	string	✔️	N/A
`idempotencyKey`	*string	➖	A header for idempotency purposes
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.SubscribersV1ControllerRemoveSubscriberResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.ErrorDto	414	application/json
apierrors.ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
apierrors.ValidationErrorDto	422	application/json
apierrors.ErrorDto	500	application/json
apierrors.APIError	4XX, 5XX	/

CreateBulk

  Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API.
  The bulk API is limited to 500 subscribers per request.

Example Usage

package main

import(
	"context"
	"os"
	novugo "github.com/novuhq/novu-go"
	"github.com/novuhq/novu-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := novugo.New(
        novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")),
    )

    res, err := s.Subscribers.CreateBulk(ctx, components.BulkSubscriberCreateDto{
        Subscribers: []components.CreateSubscriberRequestDto{
            components.CreateSubscriberRequestDto{
                SubscriberID: "<id>",
            },
        },
    }, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.BulkCreateSubscriberResponseDto != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`bulkSubscriberCreateDto`	components.BulkSubscriberCreateDto	✔️	N/A
`idempotencyKey`	*string	➖	A header for idempotency purposes
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.SubscribersV1ControllerBulkCreateSubscribersResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.ErrorDto	414	application/json
apierrors.ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
apierrors.ValidationErrorDto	422	application/json
apierrors.ErrorDto	500	application/json
apierrors.APIError	4XX, 5XX	/

Search

Search for subscribers

Example Usage

package main

import(
	"context"
	"os"
	novugo "github.com/novuhq/novu-go"
	"github.com/novuhq/novu-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := novugo.New(
        novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")),
    )

    res, err := s.Subscribers.Search(ctx, operations.SubscribersControllerSearchSubscribersRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.ListSubscribersResponseDto != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.SubscribersControllerSearchSubscribersRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.SubscribersControllerSearchSubscribersResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.ErrorDto	414	application/json
apierrors.ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
apierrors.ValidationErrorDto	422	application/json
apierrors.ErrorDto	500	application/json
apierrors.APIError	4XX, 5XX	/

Retrieve

Get subscriber by your internal id used to identify the subscriber

Example Usage

package main

import(
	"context"
	"os"
	novugo "github.com/novuhq/novu-go"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := novugo.New(
        novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")),
    )

    res, err := s.Subscribers.Retrieve(ctx, "<id>", nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.SubscriberResponseDto != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`subscriberID`	string	✔️	N/A
`idempotencyKey`	*string	➖	A header for idempotency purposes
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.SubscribersControllerGetSubscriberResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.ErrorDto	414	application/json
apierrors.ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
apierrors.ValidationErrorDto	422	application/json
apierrors.ErrorDto	500	application/json
apierrors.APIError	4XX, 5XX	/

Patch

Patch subscriber by your internal id used to identify the subscriber

Example Usage

package main

import(
	"context"
	"os"
	novugo "github.com/novuhq/novu-go"
	"github.com/novuhq/novu-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := novugo.New(
        novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")),
    )

    res, err := s.Subscribers.Patch(ctx, "<id>", components.PatchSubscriberRequestDto{}, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.SubscriberResponseDto != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`subscriberID`	string	✔️	N/A
`patchSubscriberRequestDto`	components.PatchSubscriberRequestDto	✔️	N/A
`idempotencyKey`	*string	➖	A header for idempotency purposes
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.SubscribersControllerPatchSubscriberResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.ErrorDto	414	application/json
apierrors.ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
apierrors.ValidationErrorDto	422	application/json
apierrors.ErrorDto	500	application/json
apierrors.APIError	4XX, 5XX	/

Delete

Deletes a subscriber entity from the Novu platform

Example Usage

package main

import(
	"context"
	"os"
	novugo "github.com/novuhq/novu-go"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := novugo.New(
        novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")),
    )

    res, err := s.Subscribers.Delete(ctx, "<id>", nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.RemoveSubscriberResponseDto != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`subscriberID`	string	✔️	N/A
`idempotencyKey`	*string	➖	A header for idempotency purposes
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.SubscribersControllerRemoveSubscriberResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.ErrorDto	414	application/json
apierrors.ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
apierrors.ValidationErrorDto	422	application/json
apierrors.ErrorDto	500	application/json
apierrors.APIError	4XX, 5XX	/

UpdateOnlineStatus

Used to update the subscriber isOnline flag.

Example Usage

package main

import(
	"context"
	"os"
	novugo "github.com/novuhq/novu-go"
	"github.com/novuhq/novu-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := novugo.New(
        novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")),
    )

    res, err := s.Subscribers.UpdateOnlineStatus(ctx, "<id>", components.UpdateSubscriberOnlineFlagRequestDto{
        IsOnline: true,
    }, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.SubscriberResponseDto != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`subscriberID`	string	✔️	N/A
`updateSubscriberOnlineFlagRequestDto`	components.UpdateSubscriberOnlineFlagRequestDto	✔️	N/A
`idempotencyKey`	*string	➖	A header for idempotency purposes
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.SubscribersV1ControllerUpdateSubscriberOnlineFlagResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.ErrorDto	414	application/json
apierrors.ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
apierrors.ValidationErrorDto	422	application/json
apierrors.ErrorDto	500	application/json
apierrors.APIError	4XX, 5XX	/

Files

README.md

Latest commit

History

README.md

File metadata and controls

Subscribers

Overview

Available Operations

List

Example Usage

Parameters

Response

Errors

Create

Example Usage

Parameters

Response

Errors

Get

Example Usage

Parameters

Response

Errors

Update

Example Usage

Parameters

Response

Errors

DeleteLegacy

Example Usage

Parameters

Response

Errors

CreateBulk

Example Usage

Parameters

Response

Errors

Search

Example Usage

Parameters

Response

Errors

Retrieve

Example Usage

Parameters

Response

Errors

Patch

Example Usage

Parameters

Response

Errors

Delete

Example Usage

Parameters

Response

Errors

UpdateOnlineStatus

Example Usage

Parameters

Response

Errors