---
title: /v1/events/helpline_display
slug: v1eventshelplinedisplay
docTags: 
createdAt: 2026-05-06T23:35:31.392Z
---

{
  "id": "M5rXtDFYUy4swX-mZuBA_",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "https://api.throughlinecare.com/v1/events/helpline_display",
    "description": "Record a helpline display event.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [
        {
          "kind": "required",
          "name": "HelplineDisplayV1",
          "type": "object",
          "description": "Record a helpline display event.",
          "customType": "HelplineDisplayV1",
          "schema": [
            {
              "name": "no_display",
              "kind": "optional",
              "type": "boolean",
              "description": "Set to true to record that the API was used but no helplines were displayed"
            },
            {
              "name": "helpline_id",
              "kind": "required",
              "type": "string",
              "description": "ID of the helpline"
            },
            {
              "name": "session_id",
              "kind": "required",
              "type": "string",
              "description": "<p>Client-generated session identifier</p>"
            },
            {
              "name": "timestamp",
              "kind": "required",
              "type": "string",
              "description": "ISO 8601 timestamp"
            }
          ],
          "modelRef": "#/definitions/HelplineDisplayV1",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "bearerAuth",
          "name": "Authorization",
          "kind": "optional",
          "type": "apiKey",
          "description": "<p>Enter the token with the \"Bearer: \" prefix e.g. \"Bearer ABC...\"</p>",
          "in": "header"
        }
      ]
    },
    "responses": [
      {
        "statusCode": "201",
        "description": "Event recorded successfully.",
        "jsonExample": "",
        "isExpanded": true
      },
      {
        "statusCode": "400",
        "description": "Missing or invalid required fields",
        "jsonExample": "",
        "isExpanded": true
      },
      {
        "statusCode": "401",
        "description": "Unauthorized",
        "jsonExample": "",
        "isExpanded": true
      },
      {
        "statusCode": "422",
        "description": "Invalid helpline",
        "jsonExample": "",
        "isExpanded": true
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "DO9lJCuGTxsHGlbGBN3w8",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n   \"helpline_id\": \"\",\n   \"session_id\": \"\",\n   \"timestamp\": \"\"\n});\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.throughlinecare.com/v1/events/helpline_display\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "X-GhtOhkj4jsRSLCes0d4",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.throughlinecare.com/v1/events/helpline_display\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n   \"helpline_id\": \"\",\n   \"session_id\": \"\",\n   \"timestamp\": \"\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "VeTYYT0tlodnDHSFjv7V7",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.throughlinecare.com/v1/events/helpline_display\"\n\npayload = json.dumps({\n   \"helpline_id\": \"\",\n   \"session_id\": \"\",\n   \"timestamp\": \"\"\n})\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        },
        {
          "id": "Mtb4rnlpiVN-QFRj7hi9M",
          "language": "java",
          "label": "Java",
          "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n   .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n  \\\"helpline_id\\\": \\\"\\\",\\n  \\\"session_id\\\": \\\"\\\",\\n  \\\"timestamp\\\": \\\"\\\"\\n}\");\nRequest request = new Request.Builder()\n   .url(\"https://api.throughlinecare.com/v1/events/helpline_display\")\n   .method(\"POST\", body)\n   .addHeader(\"accept\", \"application/json\")\n   .addHeader(\"content-type\", \"application/json\")\n   .build();\nResponse response = client.newCall(request).execute();"
        },
        {
          "id": "KRx_ZhgfVetURsYS1dfps",
          "language": "swift",
          "label": "Swift",
          "code": "let parameters = \"{\\n  \\\"helpline_id\\\": \\\"\\\",\\n  \\\"session_id\\\": \\\"\\\",\\n  \\\"timestamp\\\": \\\"\\\"\\n}\"\nlet postData = parameters.data(using: .utf8)\n\nvar request = URLRequest(url: URL(string: \"https://api.throughlinecare.com/v1/events/helpline_display\")!,timeoutInterval: Double.infinity)\nrequest.addValue(\"application/json\", forHTTPHeaderField: \"accept\")\nrequest.addValue(\"application/json\", forHTTPHeaderField: \"content-type\")\n\nrequest.httpMethod = \"POST\"\nrequest.httpBody = postData\n\nlet task = URLSession.shared.dataTask(with: request) { data, response, error in \n   guard let data = data else {\n      print(String(describing: error))\n      return\n   }\n   print(String(data: data, encoding: .utf8)!)\n}\n\ntask.resume()\n"
        }
      ],
      "selectedLanguageId": "DO9lJCuGTxsHGlbGBN3w8"
    },
    "results": {
      "languages": [
        {
          "id": "JxpBuQclbg7mWUVr--i5W",
          "language": "201",
          "code": "// Event recorded successfully.\n"
        },
        {
          "id": "SMDcBKEI6odIK1ur7M3YJ",
          "language": "400",
          "code": "// Missing or invalid required fields\n"
        },
        {
          "id": "FuD5dOWrcgIyuP1ILzT89",
          "language": "401",
          "code": "// Unauthorized\n"
        },
        {
          "id": "iGpUUi5OJPhLJDvJdBv4n",
          "language": "422",
          "code": "// Invalid helpline\n"
        }
      ],
      "selectedLanguageId": "JxpBuQclbg7mWUVr--i5W"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}