List helpdesk message templates

/helpdesk_message_templatess/all

Target audience: Developers

Release version: 3.9.1

Get pending helpdesk messages for an account¶

Introduction¶

This endpoint returns all helpdesk message templates.

URI¶

Environment	URI
Stage	https://payway-api.stage.adeprimo.se/external/api/v1/helpdesk_message_templates/all
Production	https://backend.worldoftulo.com/external/api/v1/helpdesk_message_templates/all

Requirements¶

Identity	Scope
No	`/external/helpdesk/r`

Parameters¶

Name	Required	Type	Description
enabled	Optional	Boolean	true or false, defaults to true.

Curl Example¶

curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/helpdesk_message_templates/all?enabled=true \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <token>'

Response¶

Example response¶

HTTP 200
{
  "items": [
    {
      "id": "5b7e9fd495cfeb85c8000010",
      "heading": "Remove my personal data",
      "message": "Please remove all of my personal data.",
      "type": "request",
      "enabled": true,
      "created_at": "2018-08-23T13:51:48.036+02:00",
      "updated_at": "2024-03-12T14:35:37.127+01:00",
      "organisation": {
        "id": "adeprimoen",
        "name": "Adeprimo English",
        "locale": "en-SE"
      }
    },
    {
      "id": "5b7ea02695cfeb3874000008",
      "heading": "Send me all my personal data",
      "message": "I hereby request to get all of my personal data.",
      "type": "request",
      "enabled": true,
      "created_at": "2018-08-23T13:53:10.407+02:00",
      "updated_at": "2021-03-17T09:27:46.476+01:00",
      "organisation": {
        "id": "adeprimoen",
        "name": "Adeprimo English",
        "locale": "en-SE"
      }
    }
  ]
}

Errors¶

Example error response¶

HTTP 400 Bad Request
{
  "code": "invalid_parameter",
  "field": "enabled",
  "message": "'bogus value' is not a valid boolean",
  "pw_correlation_id": "pw-api-10ba097a-7172-4c6f-a3f6-136e27853902"
}

HTTP 400 Bad Request¶

Name	Type	Description
unknown_parameter	Object	One or more of the fields in the posted json was not recognized

HTTP 500 Internal Server Error¶

Name	Type	Description
internal_server_error	Object	Something unexpected happened server side