Struct UpdateTemplateRequest

Namespace

Vonage.VerifyV2.UpdateTemplate

Assembly

Vonage.dll

Represents a request to update a custom verification template's name or default status.

public readonly struct UpdateTemplateRequest : IVonageRequest

Implements

IVonageRequest

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

IsDefault

Whether this template should be used as the default when no template_id is specified in verification requests.

[JsonConverter(typeof(MaybeJsonConverter<bool>))]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public Maybe<bool> IsDefault { get; }

Property Value

Maybe<bool>

Name

The new reference name for the template. Must be 1-64 characters matching the pattern ^[A-Za-z0-9_-]+$ and unique within the account.

[JsonConverter(typeof(MaybeJsonConverter<string>))]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public Maybe<string> Name { get; }

Property Value

Maybe<string>

TemplateId

The unique identifier (UUID) of the template to update.

[JsonIgnore]
public Guid TemplateId { get; }

Property Value

Guid

Methods

Build()

Creates a new builder to construct an UpdateTemplateRequest.

public static IBuilderForId Build()

Returns

IBuilderForId

A builder interface to set the template ID.

Examples

var request = UpdateTemplateRequest.Build()
    .WithId(Guid.Parse("8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9"))
    .WithName("new-template-name")
    .SetAsDefaultTemplate()
    .Create();

See Also

More examples in the snippets repository

BuildRequestMessage()

Converts the request to a HttpRequest.

public HttpRequestMessage BuildRequestMessage()

Returns

HttpRequestMessage

The Http request.