Skip to main content
Use this endpoint to update your organization’s profile and compliance information. All body fields are optional — only the fields you include are updated. This is an organization context request: the path :id must match the organization in your X-Organization-Id header.

Endpoint

PATCH https://api.nyotaimara.com/v1/organizations/:id

Headers

Authorization
string
required
Bearer token. Format: Bearer <token>.
X-Organization-Id
string
required
The ID of the organization you are acting on behalf of. Must match the :id path parameter.

Path parameters

id
string
required
The unique identifier of the organization to update.

Body

All fields are optional. Omitted fields are left unchanged.
name
string
New display name for the organization.
logoUrl
string
URL of the organization’s logo image.
kraPin
string
Kenya Revenue Authority PIN.
billingEmail
string
Email address for invoices and billing notifications.
address
string
Physical street address.
city
string
City of operation.
country
string
Country of operation.

Response

success
boolean
required
true on a successful update.
message
string
Human-readable confirmation. Value: "Organization settings updated successfully."
The :id in the path must match the organization ID in the X-Organization-Id header. Attempting to update a different organization returns a 403 Forbidden error.
curl --request PATCH \
  --url https://api.nyotaimara.com/v1/organizations/org_01j9kxyz \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Organization-Id: org_01j9kxyz' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Acme Kenya Ltd",
    "billingEmail": "finance@acmekenya.co.ke",
    "city": "Mombasa"
  }'
{
  "success": true,
  "message": "Organization settings updated successfully."
}