Update a Template

patch

https://portal-cert.shieldconex.com:4010/api/v1/templates/{id}

This endpoint updates an existing Template resource. It is not neccessary to include the complete replacement object in the API call; an object containing the properties that are to be changed will suffice.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

length ≤ 20

The Template's unique identifier.

Query Params

name

string

The system name of the template. Should not include spaces or special characters except underscores.

reference

string

A reference identifier for the template.

active

boolean

Indicates if the template is published. Once set to true, the template is no longer editable."

version

int32

Version number of the template.

partner.id

int32

The ID of the partner associated with this template.

partner.name

string

The name of the partner associated with this template.

client.id

int32

The ID of the client associated with this template.

client.name

string

The name of the client associated with this template.

fieldTemplates

array of objects

fieldTemplates

type

string

enum

Specifies if the template type is user-defined or pre-defined.

Allowed:

accessMode

string

enum

Access mode of the template, e.g., specific to certain domains.

Allowed:

options.customStyles

string

Custom styles applied to the iFrame. Should be in CSS format.

options.customStyleFile

string

File path to custom style file for the iFrame.

options.domains

array of strings

List of allowed domains for the template.

options.domains

options.security.irreversible

boolean

Indicates if tokens generated by the template are irreversible.

options.security.active.from

string

The duration from the time of tokenization until the token can be detokenized. This is specified in ISO 8601 format.

options.security.active.to

date-time

The duration from the time of tokenization (not the time of activation) until the token can no longer be detokenized. This is specified in ISO 8601 format. Should be greater than the 'active from' setting. If not the token will be effectively irreversible.

Body Params

Template to be updated.

version

integer

The number of times that this resource has been updated.

name

string

The Template's name.

reference

string

The Template's unique reference.

active

boolean

This property indicates if the Template is active or inactive. In the UI this is referred to as published and when set to true the template cannot be modified.

partner

object

Reference to the associated Partner. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

client

object

Reference to the associated Client resource. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

fieldTemplates

array

Field Template list items

fieldTemplates

type

string

enum

The Template's type. TODO provide description

Allowed:

accessMode

enum

The Template's access mode. TODO provide description

Allowed:

options

object

Responses

401

Unauthorized

403

Forbidden

404

Not found

200Template update response

409Invalid data

500Internal server error