Create Organization - Documentação DEVMOB

curl --request POST \ --url https://api.example.com/api/v1/bko/organizations \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "<string>", "document": "<string>", "owner": { "phoneDdi": "<string>", "phoneNumber": "<string>", "email": "jsmith@example.com", "phoneIso": "<string>" }, "logo": "<string>", "phoneIso": "<string>", "phoneDdi": "<string>", "phoneNumber": "<string>", "email": "jsmith@example.com", "company": { "cooperativeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "anttCode": "<string>" } } '

{ "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "<string>", "document": "<string>", "logo": "<string>", "phoneIso": "<string>", "phoneDdi": "<string>", "phoneNumber": "<string>", "phoneVerified": true, "email": "<string>", "emailVerified": true, "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z", "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "updatedAt": "2023-11-07T05:31:56Z", "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "deletedAt": "2023-11-07T05:31:56Z" }

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

Create organization payload

type

enum<string>

required

Organization type

Available options:

COOPERATIVE,

COMPANY

name

string

required

Legal or trade name

document

string

required

Organization document

documentType

enum<string>

required

Document type

Available options:

CPF,

CNPJ,

RG

owner

object

required

Initial owner invite data

Show child attributes

logo

string | null

Logo object key

phoneIso

string | null

Phone ISO country code

phoneDdi

string | null

International dialing code

phoneNumber

string | null

Phone number

string<email> | null

Contact email

company

object | null

Company-specific data. Required when type is COMPANY.

Show child attributes

Response

Created

Entidade base de tenant para RBAC, cooperativas e empresas

organizationId

string<uuid>

required

Identificador único

type

enum<string>

required

Tipo da organização

Available options:

COOPERATIVE,

COMPANY

name

string

required

Razão social ou nome fantasia

document

string

required

CNPJ da organização

documentType

enum<string>

required

Tipo do documento

Available options:

CPF,

CNPJ,

RG

logo

string | null

required

Chave do objeto de armazenamento do logotipo

phoneIso

string | null

required

Código ISO do país do telefone

phoneDdi

string | null

required

DDI do telefone

phoneNumber

string | null

required

Número do telefone

phoneVerified

boolean

required

Indica se o telefone foi verificado

string | null

required

Email de contato da organização

emailVerified

boolean

required

Indica se o email foi verificado

status

enum<string>

required

Status operacional da organização

Available options:

ACTIVE,

INACTIVE,

BLOCKED

createdBy

string<uuid> | null

required

Usuário que criou o registro, quando aplicável

createdAt

string<date-time>

required

Data de criação

updatedBy

string<uuid> | null

required

Usuário que fez a última atualização, quando aplicável

updatedAt

string<date-time>

required

Data da última atualização

deletedBy

string<uuid> | null

required

Usuário que removeu o registro, quando aplicável

deletedAt

string<date-time> | null

required

Data de remoção