Skip to main content

​
Method

PATCH /v1/organizations/:id

​
Path Parameters

​
id
uuid
required
Organization ID.

​
Body Parameters

Any subset of the fields accepted by the create endpoint:
  • name
  • legalName / legal_name
  • email
  • phone
  • description
  • taxId / tax_id
  • kind
  • billingAddress / billing_address
  • visitingAddress / visiting_address
  • metadata

​
Headers

​
Authorization
string
Bearer token with organizations:write scope.
​
content-type
string
application/json

​
Request Example

curl -X PATCH https://api.voyantcloud.com/v1/organizations/org_123 \
  -H "Authorization: Bearer $VOYANT_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "phone": "+40 700 000 002",
    "metadata": {"tier": "platinum"}
  }'

​
Response

{
  "data": {
    "id": "org_123",
    "name": "Voyant Cruises",
    "legalName": "Voyant Cruises SRL",
    "email": "partners@voyantcruises.com",
    "phone": "+40 700 000 002",
    "description": "Updated partner",
    "taxId": "RO12345678",
    "kind": "wholesale",
    "billingAddress": null,
    "visitingAddress": null,
    "metadata": { "tier": "platinum" },
    "createdAt": "2025-02-20T10:00:00.000Z",
    "updatedAt": "2025-02-22T08:15:00.000Z"
  }
}
Fields omitted from the payload remain unchanged. Passing null sets nullable fields (like metadata) to null.