Support API

Use the Core API to create a support request for the authenticated user.

Endpoint

Method	Path	Description
`POST`	`/api/support`	Create a support request

GET /api/support is not supported.

Create a support request

Send a user token in the Authorization header. The web app uses category, title, and description; the handler stores the submitted fields with the authenticated user's details.

Request

curl -X POST "https://api.requestrocket.com/api/support" \
  -H "Authorization: u-your-token" \
  -H "Content-Type: application/json" \
  -d '{
  "category": "Technical Issue",
  "title": "Proxy returns 403",
  "description": "Proxy example-proxy began returning 403 at 14:20 UTC for GET /customers."
}'

import axios from "axios";

const response = await axios.request({
  method: "POST",
  url: "https://api.requestrocket.com/api/support",
  headers: {
    "Authorization": "u-your-token",
    "Content-Type": "application/json",
  },
  data: {
  "category": "Technical Issue",
  "title": "Proxy returns 403",
  "description": "Proxy example-proxy began returning 403 at 14:20 UTC for GET /customers."
}
});

console.log(response.status, response.data);

import requests

response = requests.request(
    "POST",
    "https://api.requestrocket.com/api/support",
    headers={
        "Authorization": "u-your-token",
        "Content-Type": "application/json",
    },
    data="{\n  \"category\": \"Technical Issue\",\n  \"title\": \"Proxy returns 403\",\n  \"description\": \"Proxy example-proxy began returning 403 at 14:20 UTC for GET /customers.\"\n}"
)
print(response.status_code, response.json())

package main

import (
    "fmt"
    "io"
    "net/http"
    "strings"
)

func main() {
    payload := strings.NewReader(`{
  "category": "Technical Issue",
  "title": "Proxy returns 403",
  "description": "Proxy example-proxy began returning 403 at 14:20 UTC for GET /customers."
}`)
    req, _ := http.NewRequest("POST", "https://api.requestrocket.com/api/support", payload)
    req.Header.Set("Authorization", "u-your-token")
    req.Header.Set("Content-Type", "application/json")
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(resp.StatusCode, string(body))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.requestrocket.com/api/support"))
            .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"category\": \"Technical Issue\",\n  \"title\": \"Proxy returns 403\",\n  \"description\": \"Proxy example-proxy began returning 403 at 14:20 UTC for GET /customers.\"\n}"))
            .header("Authorization", "u-your-token")
            .header("Content-Type", "application/json")
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}

Responses

{
  "message": "Support item created successfully",
  "helpItem": {
    "sKey": "support-request-id",
    "category": "Technical Issue",
    "title": "Proxy returns 403",
    "description": "Proxy example-proxy began returning 403 at 14:20 UTC for GET /customers.",
    "userId": "user-id",
    "userFirstName": "Alex",
    "userLastName": "Example",
    "userEmail": "alex@example.com"
  }
}

{
  "message": "Unauthorized"
}

{
  "message": "Error creating help item"
}

Request body

Parameter	Type	Required	Description
`category`	string	✓	Category such as `Technical Issue`, `Feature Request`, or `Billing`.
`title`	string	✓	Short summary.
`description`	string	✓	Detail of the issue or request.

Response attributes

Attribute	Type	Description
`message`	string	`Support item created successfully`.
`helpItem.sKey`	string	Support request id.
`helpItem.category`	string	Category from the request.
`helpItem.title`	string	Title from the request.
`helpItem.description`	string	Description from the request.
`helpItem.userId`	string	Authenticated user id.
`helpItem.userFirstName`	string	User's given name.
`helpItem.userLastName`	string	User's family name.
`helpItem.userEmail`	string	User's email address.

Do not include credentials or user tokens in the request body. Shared status codes and request limits are on Platform limits.

App guide

Do this in the app

System notifications

Platform-wide announcements

Community

GitHub, Discord, and LinkedIn

Organisation & team

Manage the organisation and its members