Skip to main content
PUT
Organization - Update

Authorizations

api-key
string
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 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

organization_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