Send feedback

Send feedback to Edge Impulse or get in touch with sales.

POST /api/users/{userId}/feedback

Send feedback

cURL

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/users/{userId}/feedback \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "type": "feedback",
  "subject": "<string>",
  "body": "<string>",
  "workEmail": "<string>",
  "company": "<string>",
  "jobTitle": "<string>",
  "companySize": "<string>",
  "organizationId": 123
}
'

import requests

url = "https://studio.edgeimpulse.com/v1/api/users/{userId}/feedback"

payload = {
    "type": "feedback",
    "subject": "<string>",
    "body": "<string>",
    "workEmail": "<string>",
    "company": "<string>",
    "jobTitle": "<string>",
    "companySize": "<string>",
    "organizationId": 123
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'feedback',
    subject: '<string>',
    body: JSON.stringify('<string>'),
    workEmail: '<string>',
    company: '<string>',
    jobTitle: '<string>',
    companySize: '<string>',
    organizationId: 123
  })
};

fetch('https://studio.edgeimpulse.com/v1/api/users/{userId}/feedback', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/users/{userId}/feedback",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'feedback',
    'subject' => '<string>',
    'body' => '<string>',
    'workEmail' => '<string>',
    'company' => '<string>',
    'jobTitle' => '<string>',
    'companySize' => '<string>',
    'organizationId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://studio.edgeimpulse.com/v1/api/users/{userId}/feedback"

	payload := strings.NewReader("{\n  \"type\": \"feedback\",\n  \"subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"workEmail\": \"<string>\",\n  \"company\": \"<string>\",\n  \"jobTitle\": \"<string>\",\n  \"companySize\": \"<string>\",\n  \"organizationId\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://studio.edgeimpulse.com/v1/api/users/{userId}/feedback")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"feedback\",\n  \"subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"workEmail\": \"<string>\",\n  \"company\": \"<string>\",\n  \"jobTitle\": \"<string>\",\n  \"companySize\": \"<string>\",\n  \"organizationId\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://studio.edgeimpulse.com/v1/api/users/{userId}/feedback")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"feedback\",\n  \"subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"workEmail\": \"<string>\",\n  \"company\": \"<string>\",\n  \"jobTitle\": \"<string>\",\n  \"companySize\": \"<string>\",\n  \"organizationId\": 123\n}"

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "error": "<string>"
}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

x-api-key · string · header · required

Path Parameters

userId · integer · required

User ID

Body

application/json

type · enum<string> · required

Available options: feedback

subject · string · required

The reason the user is contacting Edge Impulse Support.

body · string · required

The body of the message.

workEmail · string

The user's work email address. This is optional, if it's not provided, the registered email will be used.

company · string

The user's company. This is optional.

jobTitle · string

The user's job title. This is optional.

companySize · string

The user's company size. This is optional.

organizationId · number

The user's organization ID. This is optional.

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

error · string

Optional error description (set if 'success' was false)