Organization

Upload organization logo

Upload a new logo for your organization.

File requirements:

Formats: JPEG, PNG, GIF, WebP
Max size: 5 MB
Recommended: Square image, at least 200x200 pixels

How to upload: Send a multipart/form-data request with the file in a field named logo.

Example (curl):

curl -X POST \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -F "logo=@/path/to/logo.png" \
  https://api.hyperprop.com/platform/v1/organization/profile/logo

Example (JavaScript):

const formData = new FormData();
formData.append('logo', fileInput.files[0]);

fetch('/platform/v1/organization/profile/logo', {
  method: 'POST',
  headers: { 'Authorization': 'Bearer ' + token },
  body: formData
});

What happens:

Old logo is deleted (if exists)
New logo is uploaded to storage
Organization profile is updated with new URL
New logo URL is returned

Permissions: Only organization admins can upload logos.

POST

organization

profile

logo

Upload organization logo

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/profile/logo

const options = {method: 'POST'};

fetch('https://api.hyperprop.com/platform/v1/organization/profile/logo', 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://api.hyperprop.com/platform/v1/organization/profile/logo",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/profile/logo"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/profile/logo")

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

request = Net::HTTP::Post.new(url)

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

{
  "success": true,
  "message": "Logo uploaded successfully",
  "data": {
    "logoUrl": "https://storage.hyperprop.com/logos/apex-trading-a1b2c3.png"
  }
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Invalid file type. Allowed: JPEG, PNG, GIF, WebP",
  "code": "INVALID_FILE_TYPE"
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired session"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Only organization admins can perform this action",
  "code": "NOT_ADMIN"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Response

Success - Logo uploaded and profile updated

success

boolean

Example:

true

message

string

Example:

"Logo uploaded successfully"

data

object

Show child attributes

⌘I

Upload organization logo

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/profile/logo

const options = {method: 'POST'};

fetch('https://api.hyperprop.com/platform/v1/organization/profile/logo', 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://api.hyperprop.com/platform/v1/organization/profile/logo",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/profile/logo"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/profile/logo")

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

request = Net::HTTP::Post.new(url)

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

{
  "success": true,
  "message": "Logo uploaded successfully",
  "data": {
    "logoUrl": "https://storage.hyperprop.com/logos/apex-trading-a1b2c3.png"
  }
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Invalid file type. Allowed: JPEG, PNG, GIF, WebP",
  "code": "INVALID_FILE_TYPE"
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired session"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Only organization admins can perform this action",
  "code": "NOT_ADMIN"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Platform API

Trade API

Market Data API

Upload organization logo

Response