Organization - Update

PUT /v2/organizations/{id}

Update an organization.

cURL

curl --request PUT \
  --url https://sandbox.hyperswitch.io/v2/organizations/{id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "organization_name": "organization_abcd"
}
'

---

Authorizations

• Name: api-key

  • Type: string (header)

  • Required: yes

  • Note: Admin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account.

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) Details about the organization

• metadata (object) Metadata is useful for storing additional, unstructured information on an object.

Response

Status: 200 — application/json Description: Organization Created

Response fields:

• id (string) — required The unique identifier for the Organization Required string length: 1 - 64 Example: "org_q98uSGAYbjEwqs0mJwnz"

• modified_at (string) — required

• created_at (string) — required

• organization_name (string | null) Name of the Organization

• organization_details (object)

• metadata (object)

• organization_type (enum) — Available options: standard, platform

Response (200)

{
  "id": "org_q98uSGAYbjEwqs0mJwnz",
  "modified_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "organization_name": "<string>",
  "organization_details": {},
  "metadata": {},
  "organization_type": "standard"
}

---

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v2/organization/organization--update.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v2/organization/organization--update

Related:

• Organization - Retrieve: https://api-reference.hyperswitch.io/v2/organization/organization--retrieve

• Organization - Merchant Account - List: https://api-reference.hyperswitch.io/v2/organization/organization--merchant-account--list