Initiate import of a style guide#
Description#
Imports a style guide to the given identifier. This operation will replace the current style guide.
Responses include an uploadUrl which indicates where to upload the style guide import. To upload the file,
perform a PUT against the uploadUrl with the same authentication credentials and flow as the import request.
For more details, see Authentication documentation. The response will also include
a Location header, which indicates where to poll for results. For more details on long-running job polling, see
Operations endpoint. When the upload completes, its status will be
completed, and the response body includes a resourceURL. To GET the style guide, perform a GET
on the resourceURL with the same authentication credentials and flow as the initial request.
POST /content/styleGuides/{styleGuideId}/import
Required OAuth Scopes
file:write
Parameters#
Parameter |
In |
Type |
Required |
Description |
|---|---|---|---|---|
X-Version |
header |
string |
true |
Version of the API (2026-01-01) |
styleGuideId |
path |
string |
true |
The unique identifier of the style guide |
Code Samples#
curl -X POST https://api.app.wdesk.com/content/styleGuides/{styleGuideId}/import \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'X-Version: 2026-01-01'
http POST https://api.app.wdesk.com/content/styleGuides/{styleGuideId}/import \
X-Version:2026-01-01 \
Accept:application/json \
Authorization:"Bearer {access-token}"
wget --method=POST "https://api.app.wdesk.com/content/styleGuides/{styleGuideId}/import" \
--output-document - \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'X-Version: 2026-01-01'
import requests
headers = {
'X-Version': '2026-01-01',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.app.wdesk.com/content/styleGuides/{styleGuideId}/import', headers = headers)
print(r.headers['Location'])
Returns#
202 - Accepted#
Returns a StyleGuideImportResponse object containing details for uploading the new style guide.
Header |
Description |
|---|---|
Location |
The location to poll for the operation result. |
Retry-After |
The number of seconds to wait before polling for a result and between polling attempts. |
400 - Bad Request#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
403 - Forbidden#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
404 - Not Found#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
409 - Conflict#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
429 - Too Many Requests#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
500 - Internal Server Error#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
Example Responses#
{
"uploadUrl": "<opaque_url>"
}
{
"code": "400BadRequest",
"message": "The request was unacceptable, often due to a missing or invalid parameter"
}
{
"code": "401Unauthorized",
"message": "No valid API token provided"
}
{
"code": "403Forbidden",
"message": "The API token does not have permissions to perform the request"
}
{
"code": "404NotFound",
"message": "The requested resource could not be found"
}
{
"code": "409Conflict",
"message": "The request conflicts with another request"
}
{
"code": "429TooManyRequests",
"message": "Too many requests have been made against the API in too short a time"
}
{
"code": "500InternalServerError",
"message": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}
{
"code": "503ServiceUnavailable",
"message": "The server cannot handle the request due to a temporary overload or scheduled maintenance"
}