Withdraw Notice

POST

/v1/notices/{notice_id}/withdraw

curl --request POST \
  --url https://example.com/v1/notices/example/withdraw \
  --header 'Content-Type: application/json' \
  --data '{ "reason": "example", "withdrawn_by": "example" }'

Withdraw a notice at any stage, with a reason. A sent notice stays sent in the record; the withdrawal is a further signed workflow record linked to the decision.

Parameters

Path Parameters

notice_id

required

Notice Id

string

Request Body^required

Media typeapplication/json

WithdrawIn

object

reason

required

Reason

string

>= 3 characters <= 1000 characters

withdrawn_by

required

Withdrawn By

string

>= 1 characters <= 256 characters

Example^generated

{
  "reason": "example",
  "withdrawn_by": "example"
}

Responses

200

Successful Response

Media typeapplication/json

Response Withdraw Notice V1 Notices Notice Id Withdraw Post

object

key

additional properties

any

Example^generated

{}

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

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}