Update a Template

You can update a Template to change its default status or its unique name.

Key	Description
`VONAGE_APPLICATION_ID`	The Vonage Application ID.
`VONAGE_APPLICATION_PRIVATE_KEY_PATH`	Private key path.
`JWT`	Used to authenticate your request. See Authentication for more information, including how to generate a JWT.
`TEMPLATE_ID`	The custom template ID

Write the code

Add the following to update-template.sh:

curl -X PATCH "https://api.nexmo.com/v2/verify/templates/$VERIFY_TEMPLATE_ID" \
  -H "Authorization: Bearer $JWT"\
  -H 'Content-Type: application/json' \
  -d $'{
	   "name": "my-renamed-template",
     "is_default": false,
  }'

View full source

Run your code

Save this file to your machine and run it:

sh update-template.sh

Prerequisites

npm install @vonage/server-sdk

Create a file named update-template.js and add the following code:

const { Vonage } = require('@vonage/server-sdk');

const vonage = new Vonage ({
  applicationId: VONAGE_APPLICATION_ID,
  privateKey: VONAGE_APPLICATION_PRIVATE_KEY_PATH,
});

View full source

Write the code

Add the following to update-template.js:

vonage.verify2.getTemplateFragment(
  VERIFY_TEMPLATE_ID,
  {
    name: 'Updated template name',
    isDefault: true,
  },
)
  .then((fragment) => console.log(fragment))
  .catch((error) => console.error(error));

View full source

Run your code

Save this file to your machine and run it:

node update-template.js

Prerequisites

Add the following to build.gradle:

implementation 'com.vonage:server-sdk-kotlin:2.1.1'

Create a file named UpdateTemplate and add the following code to the main method:

val client = Vonage {
    applicationId(VONAGE_APPLICATION_ID)
    privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
}

View full source

Write the code

Add the following to the main method of the UpdateTemplate file:

val existingTemplate = client.verify.template(VERIFY_TEMPLATE_ID)
val updatedTemplate = existingTemplate.update(
    name = VERIFY_TEMPLATE_NAME, isDefault = false
)
println(updatedTemplate)

View full source

Run your code

We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Run the following gradle command to execute your application, replacing com.vonage.quickstart.kt.verify.templates with the package containing UpdateTemplate:

gradle run -Pmain=com.vonage.quickstart.kt.verify.templates.UpdateTemplate

Prerequisites

Add the following to build.gradle:

implementation 'com.vonage:server-sdk:9.3.1'

Create a file named UpdateTemplate and add the following code to the main method:

VonageClient client = VonageClient.builder()
		.applicationId(VONAGE_APPLICATION_ID)
		.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
		.build();

View full source

Write the code

Add the following to the main method of the UpdateTemplate file:

var updated = client.getVerify2Client().updateTemplate(VERIFY_TEMPLATE_ID, VERIFY_TEMPLATE_NAME, false);
System.out.println(updated);

View full source

Run your code

We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Run the following gradle command to execute your application, replacing com.vonage.quickstart.verify2.templates with the package containing UpdateTemplate:

gradle run -Pmain=com.vonage.quickstart.verify2.templates.UpdateTemplate

Prerequisites

Install-Package Vonage

Create a file named UpdateTemplateRequest.cs and add the following code:

var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_APPLICATION_PRIVATE_KEY_PATH);
var client = new VonageClient(credentials);

View full source

Write the code

Add the following to UpdateTemplateRequest.cs:

var request = Vonage.VerifyV2.UpdateTemplate.UpdateTemplateRequest.Build()
    .WithId(TEMPLATE_ID)
    .WithName("my-renamed-template")
    .SetAsNonDefaultTemplate()
    .Create();
var response = await client.VerifyV2Client.UpdateTemplateAsync(request);

View full source

Prerequisites

composer require vonage/client

Create a file named update-template.php and add the following code:

$client = new Vonage\Client(
    new Vonage\Client\Credentials\Keypair(VONAGE_APPLICATION_PRIVATE_KEY_PATH, VONAGE_APPLICATION_ID),
);

View full source

Write the code

Add the following to update-template.php:

$updateRequest = new UpdateCustomTemplateRequest('my-renamed-template', true);

$client->verify2()->updateCustomTemplate(TEMPLATE_ID, $updateRequest);

View full source

Run your code

Save this file to your machine and run it:

php update-template.php

Prerequisites

gem install vonage

Create a file named update-template.rb and add the following code:

View full source

Write the code

Add the following to update-template.rb:

View full source

Run your code

Save this file to your machine and run it:

ruby update-template.rb