Skip to content
stratldocs
Open the portal
Developer docs

Send Notice

POST
/v1/notices/{notice_id}/send
curl --request POST \
  --url https://example.com/v1/notices/example/send \
  --header 'Content-Type: application/json' \
  --data '{ "channel": "email", "to": "example", "recipient": {}, "sent_by": "example" }'

Send an approved notice. By email, Stratl delivers it through the email provider and keeps the provider’s message id; by post, portal or other, it records that it was sent elsewhere. Either way the send is a signed workflow record linked to the decision.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
notice_id
required
Notice Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
SendIn

email means Stratl sends the notice itself, to to (or the recipient’s stored email), and records the provider’s answer. Every other channel records that it was sent elsewhere.

object
channel
Channel
string
default: email
Allowed values: email post portal other
to
Any of:
string
<= 320 characters
recipient
Any of:
object
key
additional properties
any
sent_by
required
Sent By
string
>= 1 characters

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Send Notice V1 Notices Notice Id Send 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": {}
    }
  ]
}