Mark the contact cleanup report shown

PUT

/api/privacy/cleanup

curl --request PUT \
  --url http://127.0.0.1:8765/api/privacy/cleanup \
  --header 'Content-Type: application/json' \
  --data '{ "shown": true }'

Record that the cleanup report was shown.

Request Body^required

Media typeapplication/json

object

shown

required

Always true.

boolean

Example

{
  "shown": true
}

Responses

200

Success.

Media typeapplication/json

object

schema_version

required

Allowed value: scout-contact-cleanup-report:1

key

additional properties

any

Example

{
  "schema_version": "scout-contact-cleanup-report:1",
  "shown": true
}

403

Forbidden / forbidden_origin: loopback peer and Host 127.0.0.1:<port> or localhost:<port> only (Origin too on writes).

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example^generated

{
  "error": {
    "allowed_keys": [
      "example"
    ],
    "code": "example",
    "message": "example"
  }
}

404

Target_unavailable

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example

{
  "error": {
    "code": "target_unavailable",
    "message": "..."
  }
}

409

Cleanup_not_run

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example

{
  "error": {
    "code": "cleanup_not_run",
    "message": "..."
  }
}

415

Unsupported_media_type: writes need Content-Type: application/json.

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example^generated

{
  "error": {
    "allowed_keys": [
      "example"
    ],
    "code": "example",
    "message": "example"
  }
}

422

Invalid_value

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example

{
  "error": {
    "code": "invalid_value",
    "message": "..."
  }
}

500

Cleanup_state_unwritable

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example

{
  "error": {
    "code": "cleanup_state_unwritable",
    "message": "..."
  }
}