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.

patch

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

≥ 1

The unique identifier of the Template to update.

Body Params

Template to be updated.

name

string

length ≤ 255

The Template's name.

reference

string

length ≤ 255

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

client

object

type

string

enum

The Template's type. TODO provide description

Allowed:

accessMode

string

enum

The Template's access mode. TODO provide description

Allowed:

options

object

integration

object

fieldTemplates

array

fieldTemplates

version

int32

The number of times that this resource has been updated.

Responses

Language

Credentials

http

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The request has succeeded.

401Access is unauthorized.

403Access is forbidden.

404The server cannot find the requested resource.

409The request conflicts with the current state of the server.

429Too many requests.

500Server error