Skip to content
stratldocs
Open the portal
Developer docs

Place Hold

POST
/v1/holds
curl --request POST \
  --url https://example.com/v1/holds \
  --header 'Content-Type: application/json' \
  --data '{ "scope": "decision", "decision_id": "example", "subject_type": "example", "subject_id": "example", "reason": "example", "placed_by": "example", "authority": "example" }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
HoldIn
object
scope
required
Scope
string
Allowed values: decision subject
decision_id
Any of:
string
subject_type
Any of:
string
subject_id
Any of:
string
reason
required
Reason
string
>= 3 characters <= 1000 characters
placed_by
required
Placed By
string
>= 1 characters <= 256 characters
authority
Any of:
string

Responses

Section titled “ Responses ”

201

Section titled “201”

Successful Response

Media typeapplication/json
Response Place Hold V1 Holds Post
object
key
additional properties
any
Examplegenerated
{}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}