Organization - Update

PUT /organization/{id}

Update an existing organization.

cURL

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

Example Response (200)

application/json

{
  "organization_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"
}

Authorizations

• api-key (header, required) Admin API keys allow you to perform some privileged actions such as creating a merchant account and Merchant 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 distinguisher 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 (200, application/json)

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

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

• organization_type (enum) Available options: standard, platform

Edit or report an issue

Suggest edits Raise issue