Get helpdesk message template

/helpdesk_message_templates

Target audience: Developers

Release version: 3.9.1

Get account¶

Introduction¶

This endpoint returns a helpdesk message template identified by the supplied id.

URI¶

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

Requirements¶

Identity	Scope
No	`/external/helpdesk/r`

Parameters¶

Name	Required	Type	Description
id	Required	String	The id of the helpdesk message template to fetch. Size range: ..24 Allowed values: "/^[a-f\d]{24}$/i"

Curl Example¶

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

Response¶

Example response¶

HTTP 200
{
  "item": {
    "id": "66166781ad659dfeb3320fe6",
    "account_id": "66166711ad659dfeb3320fd6",
    "account": {
      "id": "66166711ad659dfeb3320fd6",
      "first_name": "John",
      "last_name": "Doe",
      "contact_email": "john1@email.com",
      "mobile_number": null,
      "customer_number": null,
      "status": "active",
      "verified": false,
      "has_products": false
    },
    "assignee_id": "",
    "assignee": null,
    "created_at": "2024-04-10T12:18:41.176+02:00",
    "updated_at": "2024-04-10T12:18:41.176+02:00",
    "resolved_at": null,
    "heading": "remove personal data",
    "message": "Please remove all my personal data",
    "type": "request",
    "identifier": "5b7e9fd495cfeb85c8000010",
    "state": "pending",
    "occurrences": 1,
    "comments": []
  }
}

Errors¶

Example error response¶

HTTP 400 Bad Request
{
  "code": "invalid_parameter",
  "field": "id",
  "message": "Parameter must match format (?i-mx:^[a-f\\d]{24}$)",
  "pw_correlation_id": "pw-api-e8bfd3f5-031e-446c-8bd4-66e0700400d0"
}

HTTP 400 Bad Request¶

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

HTTP 404 Not Found¶

Name	Type	Description
not_found	Object	The helpdesk message template could not be found

HTTP 500 Internal Server Error¶

Name	Type	Description
internal_server_error	Object	Something unexpected happened server side