Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 1.25 KB

paperlessSettingsOptIn.md

File metadata and controls

49 lines (32 loc) · 1.25 KB
Raw

Paperless Settings

Sets or Updates the user's paperless opt-in preference settings.

The acceptance is based off the user being shown and agreeing to, these Terms and Conditions

  • URL

    /profile/preferences/paperless-settings/opt-in

  • Method:

    POST

  • Request body

{
    "generic": {
        "accepted":true
    },
    "email": "[email protected]"
}

  • Success Response:

    • Code: 200
      Description: Update to an existing record
    • Code: 201
      Description: Created a new record

  • Error Response:

    • Code: 400 BAD REQUEST
      Content: {"code":"BAD_REQUEST","message":"JSON error flattened to a string describing the error that occured on the request"}

    • Code: 401 UNAUTHORIZED
      Content: {"code":"UNAUTHORIZED","message":"NINO does not exist on account"}

    • Code: 401 UNAUTHORIZED
      Content: {"code":"LOW_CONFIDENCE_LEVEL","Confidence Level on account does not allow access"}

    • Code: 406 NOT ACCEPTABLE
      Content: {"code":"ACCEPT_HEADER_INVALID","message":"The accept header is missing or invalid"}

    • Code: 500 INTERNAL_SERVER_ERROR