Skip to main content
PATCH
Update Organization

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Body

application/json

Update organization payload

name
string

Display name

Example:

"Cooperativa Metropolitana"

Legal name

Example:

"Cooperativa Metropolitana de Transporte Ltda."

tradeName
string | null

Trade name

Example:

"Metropolitana"

logo
string | null

Logo object key

Example:

"organizations/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/logo/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png"

phoneIso
string | null

Phone country code

Example:

"BR"

phoneDdi
string | null

International dialing code

Example:

"+55"

phoneNumber
string | null

Phone number

Example:

"1133334444"

email
string<email> | null

Contact email

Example:

"contato@estrela.com"

Response

OK

Organization

organizationId
string<uuid>
required

Organization identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

type
enum<string>
required

Organization type

Available options:
COOPERATIVE,
COMPANY
Example:

"COOPERATIVE"

name
string
required

Display name

Example:

"Cooperativa Metropolitana"

document
any
required

CNPJ

Example:

"45.723.174/0001-10"

documentType
enum<string>
required

Document type

Available options:
CPF,
CNPJ,
RG
Example:

"CNPJ"

phoneVerified
boolean
required

Phone verified

Example:

false

emailVerified
boolean
required

Email verified

Example:

false

status
enum<string>
required

Organization status

Available options:
ACTIVE,
INACTIVE,
BLOCKED
Example:

"ACTIVE"

cooperative
object | null
required

Cooperative extension

company
object | null
required

Company extension

address
object | null
required

Organization address

createdAt
string<date-time>
required

Created at

Example:

"2026-01-01T00:00:00.000Z"

updatedAt
string<date-time>
required

Updated at

Example:

"2026-01-01T00:00:00.000Z"

Legal name

Example:

"Cooperativa Metropolitana de Transporte Ltda."

tradeName
string | null

Trade name

Example:

"Metropolitana"

logo
string | null

Logo object key

Example:

"organizations/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/logo/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png"

phoneIso
any | null

Phone country code

Example:

"BR"

phoneDdi
any | null

International dialing code

Example:

"+55"

phoneNumber
any | null

Phone number

Example:

"1133334444"

email
any | null

Contact email

Example:

"contato@estrela.com"

createdBy
string<uuid> | null

Created by

Example:

null

updatedBy
string<uuid> | null

Updated by

Example:

null

deletedBy
string<uuid> | null

Deleted by

Example:

null

deletedAt
string<date-time> | null

Deleted at

Example:

null