SMAO API Documentation
Distributor API v1Organizations

Update organization

PATCH
/organizations/{organizationId}

Update allowed fields on a partner-managed organization. At least one field must be provided. If externalCustomerId is changed, uniqueness is enforced within the partner's organizations.

Authorization

DistributorApiKey
AuthorizationBearer <token>

Long-lived distributor API key scoped to a channel partner on the shared smao instance.

In: header

Path Parameters

organizationId*string

MongoDB ObjectId of the organization.

Match^[a-fA-F0-9]{24}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Properties1 <= properties

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/organizations/665abc123def456789012345" \  -H "Content-Type: application/json" \  -d '{    "name": "Acme GmbH (renamed)",    "externalContractId": "CON-2026-0002"  }'
{  "status": "success",  "organization": {    "id": "69c175970f3e28310926a1aa",    "name": "string",    "industry": "string",    "timezone": "string",    "channelPartner": "acme",    "externalCustomerId": "string",    "externalContractId": "string",    "partnerId": "665abc123def456789012345",    "ownerEmail": "user@example.com",    "createdAt": "2019-08-24T14:15:22Z",    "plan": {      "id": "6967b1c7138bed3e7f6bf7e6",      "slug": "string",      "name": "string",      "commitment": "none",      "currency": "string",      "baseFee": 0    }  }}