Skip to main content
PUT
/
v2
/
organizations
/
{id}
Organization - Update
curl --request PUT \
  --url https://sandbox.hyperswitch.io/v2/organizations/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization_name": "organization_abcd"
}
'
import requests

url = "https://sandbox.hyperswitch.io/v2/organizations/{id}"

payload = { "organization_name": "organization_abcd" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({organization_name: 'organization_abcd'})
};

fetch('https://sandbox.hyperswitch.io/v2/organizations/{id}', 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://sandbox.hyperswitch.io/v2/organizations/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'organization_name' => 'organization_abcd'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);

$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://sandbox.hyperswitch.io/v2/organizations/{id}"

payload := strings.NewReader("{\n \"organization_name\": \"organization_abcd\"\n}")

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

req.Header.Add("Authorization", "<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.put("https://sandbox.hyperswitch.io/v2/organizations/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"organization_name\": \"organization_abcd\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.hyperswitch.io/v2/organizations/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organization_name\": \"organization_abcd\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "org_q98uSGAYbjEwqs0mJwnz",
  "modified_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "organization_name": "<string>",
  "organization_details": {},
  "metadata": {}
}

Authorizations

Authorization
string
header
required

Format: admin-api-key=<admin-api-key>

Admin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account. This is only used during development.

Path Parameters

id
string
required

The unique identifier for the Organization

Body

application/json
platform_merchant_id
string
required

Platform merchant id is unique distiguisher for special merchant in the platform org

organization_name
string | null

Name of the organization

organization_details
object | null

Details about the organization

metadata
object | null

Metadata is useful for storing additional, unstructured information on an object.

Response

Organization Created

id
string
required

The unique identifier for the Organization

Required string length: 1 - 64
Example:

"org_q98uSGAYbjEwqs0mJwnz"

modified_at
string<date-time>
required
created_at
string<date-time>
required
organization_name
string | null

Name of the Organization

organization_details
object | null

Details about the organization

metadata
object | null

Metadata is useful for storing additional, unstructured information on an object.

organization_type
enum<string> | null
Available options:
standard,
platform