POST
/
api
/
v2.1
/
misc
/
organization
/
suspendOrganization
curl --request POST \
  --url https://sandbox.finhub.cloud/api/v2.1/misc/organization/suspendOrganization \
  --header 'Content-Type: application/json' \
  --header 'X-Forwarded-For: <x-forwarded-for>' \
  --data '{
  "organizationId": "<string>",
  "reason": "<string>",
  "suspendedBy": "<string>",
  "suspendedAt": "<string>",
  "permanent": true
}'
{
  "success": true,
  "message": "<string>",
  "data": "<any>"
}

Headers

X-Forwarded-For
string
required

Forwarded client IP address

User-Agent
string

Client user agent information

X-Tenant-ID
string

Tenant identifier for multi-tenant operations

Body

application/json

Response

200
application/json

Successful operation

The response is of type object.