SapanBaseDevelopers

Create a support request

Creates a ticket in your inbox from your own app or form. Call it from your server: the API key is secret, so a browser form should post to your backend, which calls this. Pass userId for a signed-in user to tie the request to them, and customFields for the rest of your form (e.g. a reason dropdown). Send an Idempotency-Key so a double-submitted form creates one ticket. Scope: support:write.

POSThttps://api.helpbento.com/v1/support-requests

Authentication

AuthorizationstringheaderBearer <token>required

An API key, e.g. hb_live_… (live) or hb_test_… (test).

Header parameters

1 param
  • Idempotency-Keystringlength: 0…255

    Optional idempotency key (1–255 chars). Repeating a mutating request with the same key within 24h replays the original response instead of re-executing it; a concurrent in-flight request with the same key returns 409. Use a unique key (e.g. a UUID) per logical operation so network retries are safe.

Request body

application/jsonrequired
  • emailstringemailrequired
  • namestring
  • subjectstring
  • messagestringrequired
  • userIdstringlength: 0…255

    Your app's id for a signed-in user. The request is tied to that verified user and joins their contact (the same one their identified widget chats use). Only send it from your server, for a user you have authenticated.

  • customFieldsmap of one of

    Extra form answers shown on the request in the inbox, e.g. { "reason": "Billing" }. Flat string / number / boolean values (strings up to 500 characters); keys are 1-40 letters, numbers, spaces or _ . - # / ( ) ?. Null and empty values are dropped.

Responses

  • idstring
  • statusstringpending
Errors