Difference between revisions of "API Remove Template Fields"

From IVS Wiki
Jump to: navigation, search
(Created page with "This API call will delete an existing field from a template. ===Resource URL=== <pre>http://valt.example.com/api/v3/admin/users/{templateid}/fields/{fieldid}/delete</pre> ''R...")
 
(No difference)

Latest revision as of 13:36, 14 April 2020

This API call will delete an existing field from a template.

Resource URL

http://valt.example.com/api/v3/admin/users/{templateid}/fields/{fieldid}/delete

Replace {templateid} with the actual id number of the template. Templates are numbered sequentially when added to VALT.

Replace {fieldid} with the actual id number of the field. Fields are numbered sequentially when added to VALT.

Resource Information

Method POST
Response Type JSON
Authentication Required Yes

Parameters

No parameters are required for this API call.

Response

Code Reason
200 Request Successful
401 Unauthorized
404 Field Not Found
JSON Response
data
message Deleted

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/admin/templates/3/fields/159/delete?access_token=e82632d19c523678fea3d1016c6df9e9

Successful Response

{
"data":{
"message": "Deleted"
}
}

Failure Response

{
"error":{
"code": 404
}
}