Home Page > Integration > REST API > Keywords

Keywords

Keywords - /REST/1/Keywords/:id

This endpoint is used for manipulating Keyword resources within the system. Objects are always returned in a JSON format within an array. Empty results return an empty array.

 

Object

The Keyword resource is represented with the following JSON object:

[
     {
         "id": "<int>",
         "keyword_category_id": "<int>",
         "name": "<string>"
     }
]

 

GET

As with other resources, this resource is subject to the global parameters mentioned in the REST Overview.

 

PUT

The following JSON parameters are available when updating a resource:

 

JSON Parameter Allowed value
name string

 

POST

The following JSON parameters are required when creating a resource:

 

JSON Parameter Allowed value
keyword_category_id int
name string

 

DELETE

The resource can be deleted using this verb and including the id in the endpoint URL.

 

 

Last modified
07:16, 20 Mar 2015

Tags

This page has no custom tags.

Classifications

This page has no classifications.