Skip to content

Latest commit

 

History

History
186 lines (127 loc) · 16.2 KB

README.md

File metadata and controls

186 lines (127 loc) · 16.2 KB

EmailSMSTemplates

(EmailSMSTemplates)

Overview

Available Operations

  • List - List all templates ⚠️ Deprecated
  • Get - Retrieve a template ⚠️ Deprecated
  • Revert - Revert a template ⚠️ Deprecated
  • ToggleTemplateDelivery - Toggle the delivery by Clerk for a template of a given type and slug ⚠️ Deprecated

List

Returns a list of all templates. The templates are returned sorted by position.

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

Example Usage

using Clerk.BackendAPI;
using Clerk.BackendAPI.Models.Components;
using Clerk.BackendAPI.Models.Operations;

var sdk = new ClerkBackendApi(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.EmailSMSTemplates.ListAsync(
    templateType: TemplateType.Email,
    paginated: false,
    limit: 20,
    offset: 10
);

// handle response

Parameters

Parameter Type Required Description Example
TemplateType TemplateType ✔️ The type of templates to list (email or SMS) email
Paginated bool ➖ Whether to paginate the results.
If true, the results will be paginated.
If false, the results will not be paginated.
Limit long ➖ Applies a limit to the number of results returned.
Can be used for paginating the results together with offset.		 20
Offset long ➖ Skip the first offset results when paginating.
Needs to be an integer greater or equal to zero.
To be used in conjunction with limit.		 10

Response

GetTemplateListResponse

Errors

Error Type Status Code Content Type
Clerk.BackendAPI.Models.Errors.ClerkErrors 400, 401, 422 application/json
Clerk.BackendAPI.Models.Errors.SDKError 4XX, 5XX */*

Get

Returns the details of a template

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

Example Usage

using Clerk.BackendAPI;
using Clerk.BackendAPI.Models.Components;
using Clerk.BackendAPI.Models.Operations;

var sdk = new ClerkBackendApi(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.EmailSMSTemplates.GetAsync(
    templateType: PathParamTemplateType.Email,
    slug: "welcome-email"
);

// handle response

Parameters

Parameter Type Required Description Example
TemplateType PathParamTemplateType ✔️ The type of templates to retrieve (email or SMS) email
Slug string ✔️ The slug (i.e. machine-friendly name) of the template to retrieve welcome-email

Response

GetTemplateResponse

Errors

Error Type Status Code Content Type
Clerk.BackendAPI.Models.Errors.ClerkErrors 400, 401, 404 application/json
Clerk.BackendAPI.Models.Errors.SDKError 4XX, 5XX */*

Revert

Reverts an updated template to its default state

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

Example Usage

using Clerk.BackendAPI;
using Clerk.BackendAPI.Models.Components;
using Clerk.BackendAPI.Models.Operations;

var sdk = new ClerkBackendApi(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.EmailSMSTemplates.RevertAsync(
    templateType: RevertTemplatePathParamTemplateType.Email,
    slug: "welcome-email"
);

// handle response

Parameters

Parameter Type Required Description Example
TemplateType RevertTemplatePathParamTemplateType ✔️ The type of template to revert email
Slug string ✔️ The slug of the template to revert welcome-email

Response

RevertTemplateResponse

Errors

Error Type Status Code Content Type
Clerk.BackendAPI.Models.Errors.ClerkErrors 400, 401, 402, 404 application/json
Clerk.BackendAPI.Models.Errors.SDKError 4XX, 5XX */*

ToggleTemplateDelivery

Toggles the delivery by Clerk for a template of a given type and slug. If disabled, Clerk will not deliver the resulting email or SMS. The app developer will need to listen to the email.created or sms.created webhooks in order to handle delivery themselves.

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

Example Usage

using Clerk.BackendAPI;
using Clerk.BackendAPI.Models.Components;
using Clerk.BackendAPI.Models.Operations;

var sdk = new ClerkBackendApi(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.EmailSMSTemplates.ToggleTemplateDeliveryAsync(
    templateType: ToggleTemplateDeliveryPathParamTemplateType.Email,
    slug: "welcome-email",
    requestBody: new ToggleTemplateDeliveryRequestBody() {
        DeliveredByClerk = true,
    }
);

// handle response

Parameters

Parameter Type Required Description Example
TemplateType ToggleTemplateDeliveryPathParamTemplateType ✔️ The type of template to toggle delivery for email
Slug string ✔️ The slug of the template for which to toggle delivery welcome-email
RequestBody ToggleTemplateDeliveryRequestBody ➖ N/A

Response

ToggleTemplateDeliveryResponse

Errors

Error Type Status Code Content Type
Clerk.BackendAPI.Models.Errors.ClerkErrors 400, 401, 404 application/json
Clerk.BackendAPI.Models.Errors.SDKError 4XX, 5XX */*