Interaction Model Catalog Management REST API Reference
Use the Interaction Model Catalog Management REST API to create and manage external data sources for slot type values. In your custom voice interaction model, you can create a slot type that references an external data source by catalog ID and version number. For example, instead of entering ingredients as slot type values in your recipe skill, you specify the catalog identifier for your external data source that contains the list of ingredients.
To create a reference-based interaction model catalog, use the following APIs to create the catalog, and then add data to a new catalog version: Create catalog and Create catalog version. Use the catalogId
and version
as a reference in a slot type in your custom interaction model.
As an option, you can create and manage the catalog by using the Alexa Skills Kit (ASK) Command Line Interface.
API endpoint
The endpoint of the Interaction Model Catalog Management API is https://api.amazonalexa.com
.
Authentication
Each API request must have an authorization header whose value is the access token retrieved from Login with Amazon (LWA). For details, see Get an Access Token for SMAPI.
Operations
The Interaction Model Catalog API includes the following operations.
Operation | HTTP method and URI |
---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Create catalog
Create an interaction model catalog to hold slot type values. To add data to the catalog, see Create catalog version.
Request
To create a catalog, you make a POST
request to the interactionModel/catalogs
resource.
Request path and header example
POST /v1/skills/api/custom/interactionModel/catalogs/
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Request path and header parameters
Parameter | Located in | Description | Type | Required |
---|---|---|---|---|
|
Header |
String |
Yes |
Request body example
{
"vendorId": "your.vendor.id.1",
"catalog": {
"name": "Cookie ingredients",
"description": "Contains recipe ingredients."
}
}
Request body properties
Property | Description | Type | Required |
---|---|---|---|
|
Identifies the vendor to which the catalog belongs. |
String |
Yes |
|
Information about the catalog. |
Object |
Yes |
|
Name of the catalog. |
String |
Yes |
|
Describes the catalog. |
String |
No |
Response
A successful response returns HTTP 200 OK
, along with the generated catalog ID.
On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message.
Response body example
The following example shows a response.
{
"catalogId": "catalog.id.1"
}
Response body properties
Property | Description | Type |
---|---|---|
|
Unique identifier for the new catalog. |
String |
HTTP status codes
Status | Description |
---|---|
|
Response body contains the generated catalog ID. |
|
Indicates that one or more properties in the request body aren't valid.
|
|
Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource. |
|
Indicates that the authorization token is valid, but the requested operation isn't allowed. |
|
Requested resource not found. |
|
Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off. |
|
Error occurred on the server. Retry the request by using exponential back-off. |
|
Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request. |
Create catalog version
Create a new version of an interaction model catalog for the specified catalog ID. After you create a catalog, you use this API to add data to a new catalog version.
The catalog must be in JSON format. The following recipe-skill example shows the catalog format.
{
"values":
[
{
"id": "id1",
"name": {
"value": "coconut milk"
}
},
{
"id": "id2",
"name": {
"value": "shallots"
}
},
{
"id": "id3",
"name": {
"value": "bell peppers"
}
}
]
}
Request
To create a new catalog version, you make a POST
request to the interactionModel/catalogs
resource.
Request path and header example
POST /v1/skills/api/custom/interactionModel/catalogs/{catalogId}/versions
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Request path and header parameters
Parameter | Located in | Description | Type | Required |
---|---|---|---|---|
|
Path |
Identifies the catalog. |
String |
Yes |
|
Header |
String |
Yes |
Request body example
{
"source": {
"type": "URL",
"url": "https://example.com/catalog/v2"
},
"description": "Version 2 contains additional recipe ingredients."
}
Request body properties
Property | Description | Type | Required |
---|---|---|---|
|
Location of the catalog. |
Object |
Yes |
|
Catalog type. Must be |
String |
Yes |
|
HTTPS URL to the catalog location. For the format of the catalog file, see the top of Create catalog version. |
String |
Yes |
|
Describes this version of the catalog. |
String |
No |
Response
A successful response returns HTTP 202 Accepted
, that indicates that the Alexa service created the specified catalog version. The response header contains a Location
parameter with a URL to the status.
On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message.
Response body example
The response has no body.
Response body properties
The response has no body.
HTTP status codes
Status | Description |
---|---|
|
Request to create the catalog version succeeded. |
|
Indicates that one or more properties in the request body aren't valid.
|
|
Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource. |
|
Indicates that the authorization token is valid, but the requested operation isn't allowed. |
|
Requested resource not found. |
|
Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off. |
|
Error occurred on the server. Retry the request by using exponential back-off. |
|
Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request. |
Delete catalog
Delete the specified interaction model catalog.
Request
To delete a catalog, you make a DELETE
request to the interactionModel/catalogs
resource.
Request path and header example
DELETE /v1/skills/api/custom/interactionModel/catalogs/{catalogId}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Request path and header parameters
Parameter | Located in | Description | Type | Required |
---|---|---|---|---|
|
Path |
Identifies the catalog. |
String |
Yes |
|
Header |
String |
Yes |
Request body example
The request has no body.
Request body properties
The response has no body.
Response
A successful response returns HTTP 204 No Content
to indicate that the catalog was deleted.
On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message.
Response body example
The response has no body.
Response body properties
The response has no body.
HTTP status codes
Status | Description |
---|---|
|
Successful deletion of the specified catalog. |
|
Indicates that one or more properties in the request body aren't valid.
|
|
Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource. |
|
Indicates that the authorization token is valid, but the requested operation isn't allowed. |
|
Requested resource not found. |
|
Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off. |
|
Error occurred on the server. Retry the request by using exponential back-off. |
|
Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request. |
Delete catalog version
Delete the specified version of the interaction model catalog.
Request
To delete a catalog version, you make a DELETE
request to the interactionModel/catalogs
resource.
Request path and header example
DELETE /v1/skills/api/custom/interactionModel/catalogs/{catalogId}/versions/{version}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Request path and header parameters
Parameter | Located in | Description | Type | Required |
---|---|---|---|---|
|
Path |
Identifies the catalog. |
String |
Yes |
|
Path |
Identifies the catalog version to delete. |
String |
Yes |
|
Header |
String |
Yes |
Request body example
The request has no body.
Request body properties
The response has no body.
Response
A successful response returns HTTP 204 No Content
to indicate that the Alexa service deleted the specified catalog version.
On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message.
Response body example
The response has no body.
Response body properties
The response has no body.
HTTP status codes
Status | Description |
---|---|
|
Successful deletion of the specified catalog version. |
|
Indicates that one or more properties in the request body aren't valid.
|
|
Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource. |
|
Indicates that the authorization token is valid, but the requested operation isn't allowed. |
|
Requested resource not found. |
|
Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off. |
|
Error occurred on the server. Retry the request by using exponential back-off. |
|
Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request. |
Get catalog
Get the definition of the interaction model catalog specified by the catalog ID.
Request
To get the catalog, you make a GET
request to the interactionModel/catalogs
resource.
Request path and header example
GET /v1/skills/api/custom/interactionModel/catalogs/{catalogId}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json
Request path and header parameters
Parameter | Located in | Description | Type | Required |
---|---|---|---|---|
|
Path |
Identifies the catalog. |
String |
Yes |
|
Header |
String |
Yes |
Request body example
The request has no body.
Request body properties
The request has no body.
Response
A successful response returns HTTP 200 OK
, along with the definition of the specified catalog.
On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message.
Response body example
{
"catalog": {
"name": "Cookie ingredients",
"description": "Contains recipe ingredients"
},
"createTime": "2019-01-06T05:26:02.430Z",
"totalVersions": "2"
}
Response body properties
Property | Description | Type |
---|---|---|
|
Information about the catalog. |
Object |
|
Name of the catalog. |
String |
|
Describes the catalog. |
String |
|
Creation date and time of the catalog. |
String |
|
Number of defined versions. |
String |
HTTP status codes
Status | Description |
---|---|
|
Response body contains details about the specified catalog. |
|
Indicates that one or more properties in the request body aren't valid.
|
|
Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource. |
|
Indicates that the authorization token is valid, but the requested operation isn't allowed. |
|
Requested resource not found. |
|
Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off. |
|
Error occurred on the server. Retry the request by using exponential back-off. |
|
Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request. |
Get catalog data
Get the data defined in the interaction model catalog specified by the catalog ID and version.
Request
To get the catalog data, you make a GET
request to the interactionModel/catalogs
resource.
Request path and header example
GET /v1/skills/api/custom/interactionModel/catalogs/{catalogId}/versions/{version}/values?maxResults={maxResults}&nextToken={nextToken}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json
Request path and header parameters
Parameter | Located in | Description | Type | Required |
---|---|---|---|---|
|
Path |
Identifies the catalog. |
String |
Yes |
|
Path |
Identifies the catalog version. |
String |
Yes |
|
Query |
Maximum number of results to return in the response. |
Integer |
No |
|
Query |
Token from the previous response. If not included, the Alexa service returns the first page of results. |
String |
No |
|
Header |
String |
Yes |
Request body example
The request has no body.
Request body properties
The request has no body.
Response
A successful response returns HTTP 200 OK
, along with the catalog data.
On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message.
Response body example
{
"values": [{
"id": "ingredient.1",
"name": {
"value": "butter",
"synonyms": ["margarine", "oil"]
}
},
{
"id": "ingredient.2",
"name": {
"value": "sugar"
}
}
],
"isTruncated": false,
"totalCount": 2,
"_links": {
"next": {
"href": "next_href"
},
"self": {
"href": "current_href"
}
}
}
Response body properties
Property | Description | Type |
---|---|---|
|
List of slot type values defined in the catalog. |
Array of objects |
|
Unique identifier for the data item. |
String |
|
Values for the data item. |
Object |
|
Slot type value. |
String |
|
(Optional) List of synonyms for the type. |
Array of string |
|
Indicates whether there are more items to return. If set to |
Boolean |
|
(Optional) Included when there are more results to return. Use this value in a subsequent request. |
String |
|
Total number of values in the catalog. |
Integer |
|
Links for item navigation. |
_links object |
HTTP status codes
Status | Description |
---|---|
|
Response body contains the data defined in the specified catalog. |
|
Indicates that one or more properties in the request body aren't valid.
|
|
Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource. |
|
Indicates that the authorization token is valid, but the requested operation isn't allowed. |
|
Requested resource not found. |
|
Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off. |
|
Error occurred on the server. Retry the request by using exponential back-off. |
|
Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request. |
Get catalog metadata
Get the metadata for the interaction model catalog specified by the catalog ID and version.
Request
To get the catalog metadata, you make a GET
request to the interactionModel/catalogs
resource.
Request path and header example
GET /v1/skills/api/custom/interactionModel/catalogs/{catalogId}/versions/{version}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json
Request path and header parameters
Parameter | Located in | Description | Type | Required |
---|---|---|---|---|
|
Path |
Identifies the catalog. |
String |
Yes |
|
Path |
Identifies the catalog version. |
String |
Yes |
|
Header |
String |
Yes |
Request body example
The request has no body.
Request body properties
The request has no body.
Response
A successful response returns HTTP 200 OK
, along with the metadata of the specified catalog version.
On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message.
Response body example
{
"source": {
"type": "URL",
"url": "https://example.com/catalog/v2"
},
"version": "catalog.version.2",
"description": "Version 2 modifies the cookie recipe ingredients"
}
Response body properties
Property | Description | Type |
---|---|---|
|
Location of the catalog. |
Object |
|
Catalog type. Must be |
String |
|
HTTPS URL to the catalog location. |
String |
|
Version number of the catalog. |
String |
|
Describes the version of the catalog. |
String |
HTTP status codes
Status | Description |
---|---|
|
Response body contains metadata of the specified catalog version. |
|
Indicates that one or more properties in the request body aren't valid.
|
|
Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource. |
|
Indicates that the authorization token is valid, but the requested operation isn't allowed. |
|
Requested resource not found. |
|
Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off. |
|
Error occurred on the server. Retry the request by using exponential back-off. |
|
Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request. |
Get catalog status
Get the status of a previous request to create or update the interaction model catalog specified by the catalog ID.
Request
To get the creation status, you make a GET
request to the interactionModel/catalogs
resource.
Request path and header example
GET /v1/skills/api/custom/interactionModel/catalogs/{catalogId}/updateRequest/{updateRequestId}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json
Request path and header parameters
Parameter | Located in | Description | Type | Required |
---|---|---|---|---|
|
Path |
Identifies the catalog. |
String |
Yes |
|
Path |
Identifies the previous request to create or update the catalog.
Valid value: |
String |
Yes |
|
Header |
String |
Yes |
Request body example
The request has no body.
Request body properties
The request has no body.
Response
A successful response returns HTTP 200 OK
, along with the status of the specified catalog modification.
On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message.
Response body example
{
"lastUpdateRequest": {
"status": "SUCCEEDED",
"version": "2"
}
}
Response body properties
Property | Description | Type |
---|---|---|
|
Information related to the last request to create or update the catalog specified by the catalog ID. |
Object |
|
Status of the create or update request. |
String |
|
Version of the interaction model catalog. |
String |
|
(Optional) List of errors that occurred for the request. |
Array of objects |
|
HTTP status code that reflects the error. |
String |
|
Human readable error message. |
String |
HTTP status codes
Status | Description |
---|---|
|
Response body contains status of the catalog creation. |
|
Indicates that one or more properties in the request body aren't valid.
|
|
Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource. |
|
Indicates that the authorization token is valid, but the requested operation isn't allowed. |
|
Requested resource not found. |
|
Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off. |
|
Error occurred on the server. Retry the request by using exponential back-off. |
|
Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request. |
List catalogs
List all catalogs associated with the specified vendor.
Request
To get the list of catalogs, you make a GET
request to the interactionModel/catalogs
resource.
Request path and header example
GET /v1/skills/api/custom/interactionModel/catalogs/?vendorId={vendorId}&maxResults={maxResults}&nextToken={nextToken}&sortDirection={sortDirection}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json
Request path and header parameters
Parameter | Located in | Description | Type | Required |
---|---|---|---|---|
|
Path |
Identifies the vendor. |
String |
Yes |
|
Query |
Maximum number of results to return in the response. |
Integer |
No |
|
Query |
Token from the previous response. If not included, the Alexa service returns the first page of results. |
String |
No |
|
Query |
Set the sorting direction of the results as ascending or descending order. |
String |
No |
|
Header |
String |
Yes |
Request body example
The request has no body.
Request body properties
The request has no body.
Response
A successful response returns HTTP 200 OK
, along with a list of catalogs owned by the vendor.
On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message.
Response body example
{
"catalogs": [{
"catalogId": "catalog.id.1",
"description": "Contains recipe ingredients",
"name": "Cookie ingredients",
"_links": {
"next": {
"href": "next_href"
},
"self": {
"href": "current_href"
}
}
},
{
"catalogId": "catalog.id.2",
"description": "Contains recipe ingredients",
"name": "Taco ingredients",
"_links": {
"next": {
"href": "next_href"
},
"self": {
"href": "current_href"
}
}
}
],
"isTruncated": false,
"totalCount": 2,
"_links": {
"next": {
"href": "next_href"
},
"self": {
"href": "current_href"
}
}
}
Response body properties
Property | Description | Type |
---|---|---|
|
List of catalogs owned by the specified vendor. |
Array of objects |
|
Identifies the catalog. |
String |
|
Name of the catalog. |
String |
|
Describes the catalog. |
String |
|
Links for catalog navigation. |
_links object |
|
Indicates whether there are more items to return. If set to |
Boolean |
|
(Optional) Included when there are more results to return. Use this value in a subsequent request. |
String |
|
Total number of catalog versions. |
Integer |
|
Links for item navigation. |
_links object |
HTTP status codes
Status | Description |
---|---|
|
Response body contains a list of catalogs owned by the specified vendor ID. |
|
Indicates that one or more properties in the request body aren't valid.
|
|
Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource. |
|
Indicates that the authorization token is valid, but the requested operation isn't allowed. |
|
Requested resource not found. |
|
Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off. |
|
Error occurred on the server. Retry the request by using exponential back-off. |
|
Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request. |
List catalog versions
Get all versions of the specified catalog.
Request
To get the list of catalogs, you make a GET
request to the interactionModel/catalogs
resource.
Request path and header example
GET /v1/skills/api/custom/interactionModel/catalogs/{catalogId}/versions?maxResults={maxResults}&nextToken={nextToken}&sortDirection={sortDirection}&sortField={sortField}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json
Request path and header parameters
Parameter | Located in | Description | Type | Required |
---|---|---|---|---|
|
Path |
Identifies the catalog. |
String |
Yes |
|
Query |
Maximum number of results to return in the response. |
Integer |
No |
|
Query |
Token from the previous response. If not included, the Alexa service returns the first page of results. |
String |
No |
|
Query |
Set the sorting direction of the results as ascending or descending order. |
String |
No |
|
Query |
Sort the result on the specified field in alphabetical order. |
String |
No |
|
Header |
String |
Yes |
Request body example
The request has no body.
Request body properties
The request has no body.
Response
A successful response returns HTTP 200 OK
, along with a list of versions of the specified catalog.
On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message.
Response body example
{
"catalogVersions": [{
"version": "catalog.version.1",
"description": "Version 1 contains cookie recipe ingredients",
"creationTime": "2019-01-06T05:26:02.430Z",
"_links": {
"next": {
"href": "next_href"
},
"self": {
"href": "current_href"
}
}
},
{
"version": "catalog.version.2",
"description": "Version 2 modifies the cookie recipe ingredients",
"creationTime": "2019-02-16T05:26:02.430Z",
"_links": {
"next": {
"href": "next_href"
},
"self": {
"href": "current_href"
}
}
}
],
"isTruncated": false,
"totalCount": 2,
"_links": {
"next": {
"href": "next_href"
},
"self": {
"href": "current_href"
}
}
}
Response body properties
Property | Description | Type |
---|---|---|
|
List of versions for the specified catalog in |
Array of objects |
|
Version number of the catalog. |
String |
|
Describes the version of the catalog. |
String |
|
Creation date and time of the catalog version. |
String |
|
Links for catalog navigation. |
_links object |
|
Links for item navigation. |
_links object |
|
Indicates whether there are more items to return. If set to |
Boolean |
|
(Optional) Included when there are more results to return. Use this value in a subsequent request. |
String |
|
Total number of catalog versions. |
Integer |
HTTP status codes
Status | Description |
---|---|
|
Response body contains a list of versions owned of the specified catalog. |
|
Indicates that one or more properties in the request body aren't valid.
|
|
Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource. |
|
Indicates that the authorization token is valid, but the requested operation isn't allowed. |
|
Requested resource not found. |
|
Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off. |
|
Error occurred on the server. Retry the request by using exponential back-off. |
|
Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request. |
Update catalog definition
Update the interaction model catalog definition for the specified catalog.
Request
To update a catalog, you make a POST
request to the interactionModel/catalogs
resource.
Request path and header example
POST /v1/skills/api/custom/interactionModel/catalogs/{catalogId}/update
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Request path and header parameters
Parameter | Located in | Description | Type | Required |
---|---|---|---|---|
|
Path |
Identifies the catalog. |
String |
Yes |
|
Header |
String |
Yes |
Request body example
{
"catalog": {
"name": "Butter cookie ingredients",
"description": "Updated description."
}
}
Request body properties
Property | Description | Type | Required |
---|---|---|---|
|
Information about the catalog. |
Object |
Yes |
|
Name of the catalog. |
String |
Yes |
|
Describes the catalog. |
String |
No |
Response
A successful response returns HTTP 204 No Content
to indicate that the Alexa service updated the catalog definition.
On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message.
Response body example
The response has no body.
Response body properties
The response has no body.
HTTP status codes
Status | Description |
---|---|
|
Successful update of the specified catalog definition. |
|
Indicates that one or more properties in the request body aren't valid.
|
|
Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource. |
|
Indicates that the authorization token is valid, but the requested operation isn't allowed. |
|
Requested resource not found. |
|
Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off. |
|
Error occurred on the server. Retry the request by using exponential back-off. |
|
Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request. |
Update catalog version definition
Update the interaction model catalog version definition for the specified catalog and version.
Request
To update the version definition, you make a POST
request to the interactionModel/catalogs
resource.
Request path and header example
POST /v1/skills/api/custom/interactionModel/catalogs/{catalogId}/versions/{version}/update
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Request path and header parameters
Parameter | Located in | Description | Type | Required |
---|---|---|---|---|
|
Path |
Identifies the catalog. |
String |
Yes |
|
Path |
Identifies the catalog version to update. |
String |
Yes |
|
Header |
String |
Yes |
Request body example
{
"description": "Version 2 modifies the butter cookie recipe ingredients"
}
Request body properties
Property | Description | Type | Required |
---|---|---|---|
|
Describes this version of the catalog. |
String |
No |
Response
A successful response returns HTTP 204 No Content
to indicate that the catalog version definition was updated.
On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message.
Response body example
The response has no body.
Response body properties
The response has no body.
HTTP status codes
Status | Description |
---|---|
|
Successful update of the specified catalog version definition. |
|
Indicates that one or more properties in the request body aren't valid.
|
|
Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource. |
|
Indicates that the authorization token is valid, but the requested operation isn't allowed. |
|
Requested resource not found. |
|
Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off. |
|
Error occurred on the server. Retry the request by using exponential back-off. |
|
Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request. |
Related topics
Last updated: Aug 01, 2024