Post Instruction Suggestions
Raises a suggestion against an instruction step for any caller who can read that step's instruction or step group revision, and subscribes the caller to it.
Authentication
AuthorizationBearer
OAuth 2.0 Client Credentials Flow. To obtain an access token:
-
Request API credentials from HINDSITE support to receive your
client_idandclient_secret -
Make a POST request to obtain an access token:
POST https://app.hindsiteind.com/oauth/token
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET
- The response will contain your access token:
{
"access_token": "your_access_token_here",
"token_type": "Bearer",
"expires_in": 7200,
"created_at": 1234567890
}
- Include the token in subsequent API requests:
Authorization: Bearer your_access_token_here
Request
This endpoint expects an object.
title
step_id
ID of the instruction step (from an instruction or step group revision) the suggestion is about. Takes precedence over instruction_step_id.
instruction_step_id
Alias for step_id.
description
contents
Files already uploaded to storage, attached to the suggestion.
Response
created InstructionSuggestion. The body is the JSON literal true, not the created suggestion.
Errors
402
Payment Required Error
403
Forbidden Error
422
Unprocessable Entity Error
