Submit a help form

POST /api/help

Api key

Allows users to submit help requests with metadata for pages on the site.

application/json

Body

The parameters to submit a help form.

message string Required

description from the help report
report_url string Required

email of the user to create
topic string Required

topic selected by the user

Values are Technical Issues / Bugs, Account & User Management, Feature & Improvement Requests, Training & Support, or General Question.
user_agent string Required

name of the user to create

Responses

201 application/json

Form submitted
Hide response attributes Show response attributes object
- message string
  
  description from the help report
- report_url string
  
  email of the user who submitted the report
- topic string
  
  topic selected by the user
- user_agent string
  
  User agent of the user who submitted the report
400 application/json

Bad request
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code
401 application/json

Unauthorized
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code

POST /api/help

curl \
 --request POST 'http://localhost:4000/api/help' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"topic":"Technical Issues / Bugs","message":"The app keeps crashing when I click 'Submit'","report_url":"https://dv1ehjsarorqy.cloudfront.net/account/a818b56f-5213-4770-87c1-1ab5dc0cae10","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36"}'

Request examples

{
  "topic": "Technical Issues / Bugs",
  "message": "The app keeps crashing when I click 'Submit'",
  "report_url": "https://dv1ehjsarorqy.cloudfront.net/account/a818b56f-5213-4770-87c1-1ab5dc0cae10",
  "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36"
}

Response examples (201)

{
  "topic": "Technical Issues / Bugs",
  "message": "The app keeps crashing when I click 'Submit'",
  "user_id": "f260f115-f2e6-4dde-bcab-98b10fdb8cf6",
  "user_name": "Test User",
  "account_id": "f260f115-f2e6-4dde-bcab-98b10fdb8cf8",
  "report_url": "https://dv1ehjsarorqy.cloudfront.net/account/a818b56f-5213-4770-87c1-1ab5dc0cae10",
  "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36",
  "account_name": "Test Account"
}

Response examples (201)

{
  "topic": "Technical Issues / Bugs",
  "message": "The app keeps crashing when I click 'Submit'",
  "user_id": "f260f115-f2e6-4dde-bcab-98b10fdb8cf6",
  "user_name": "Test User",
  "account_id": "f260f115-f2e6-4dde-bcab-98b10fdb8cf8",
  "report_url": "https://dv1ehjsarorqy.cloudfront.net/account/a818b56f-5213-4770-87c1-1ab5dc0cae10",
  "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36",
  "account_name": "Test Account"
}

Response examples (400)

{
  "error": "Error Reason"
}

Response examples (400)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}