How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vonage Template Fragments API

Create and modify custom template fragments in Verify

Vonage Template Fragments API is one of 59 APIs that Vonage publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 74 JSON Schema definitions.

Tagged areas include Template Fragments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 74 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 1.0.1.

Requests are made against a single base URL, https://api.nexmo.com/v2/verify.

5 operations 2 paths 16 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.1
Base URL
https://api.nexmo.com/v2/verify
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Vonage Template Fragments API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (JWT) (bearerAuth).

  • basicAuth — HTTP auth can be used for synchronous calls, for asynchronous calls and call backs use JWT authentication

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Template Fragments 5

Create and modify custom template fragments in Verify

GET
/templates/{template_id}/template_fragments
List template fragments
listTemplateFragments 3 params → 200401402404422429500
POST
/templates/{template_id}/template_fragments
Create a template fragment
addTemplateFragmentToTemplate 1 param body → 201401402403404409422429
GET
/templates/{template_id}/template_fragments/{template_fragment_id}
Get a template fragment
getTemplateFragment 2 params → 200401402404429500
PATCH
/templates/{template_id}/template_fragments/{template_fragment_id}
Update a template fragment
updateTemplateFragment 2 params body → 200401402403404422429500
DELETE
/templates/{template_id}/template_fragments/{template_fragment_id}
Delete a template fragment
deleteTemplateFragment 2 params → 204401402403404429500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are TemplateFragment (7 properties), ListFragmentsResponse (6 properties), PageLinks (5 properties), ErrorInvalidParams (5 properties). Each schema is shown below with its type and property counts.

ErrorNotFound
object
Template Fragment was not found.
4 properties 4 required
TemplateFragment
object
7 properties
ErrorConflict
object
Concurrent verifications to the same number are not allowed.
4 properties 4 required
channel
string
The channel name
ErrorInternalError
object
There was an error processing your request in the Platform.
4 properties 4 required
Link
object
1 property 1 required
ErrorJwtExpired
object
JWT expired
4 properties 4 required
ErrorPaymentRequired
object
This request could not be performed due to your account balance being low.
4 properties 4 required
ErrorForbidden
object
Templates management is not enabled for your account.
4 properties 4 required
PageLinks
object
5 properties
text
string
The template text. There are 4 reserved variables available to use: ${code}, ${brand}, ${time-limit} and ${time-limit-unit}
ErrorUnauthorizedMissingCredentials
object
Invalid Credentials
4 properties 4 required
ErrorInvalidParams
object
5 properties
ListFragmentsResponse
object
6 properties 6 required
locale
string
The locale code, in lowercase
ErrorRateLimited
object
Please wait, then retry your request.
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vonage-template-fragments-api-openapi.yml Raw ↑

Other APIs Vonage publishes across the network.

Vonage Account API
Vonage Advanced API
Vonage Application API
Vonage Applications API
Vonage Archives API
Vonage Audio Connector API
Vonage Balance API
Vonage Basic API
Vonage Broadcast API
Vonage Calls API
Vonage Configuration API
Vonage Conversation API
Where this information came from

This is an independent, third-party profile of Vonage Template Fragments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.