Skip to main content
PATCH
/
api
/
v1
/
ops
/
employees
/
{employeeId}
Update Employee
curl --request PATCH \
  --url https://api.example.com/api/v1/ops/employees/{employeeId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "employeeCode": "<string>",
  "jobTitle": "<string>",
  "department": "<string>"
}
'
{
  "employeeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "membershipId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "membership": {
    "membershipId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user": {
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "email": "jsmith@example.com",
    "phoneIso": "<string>",
    "phoneDdi": "<string>",
    "phoneNumber": "<string>",
    "phoneVerified": true,
    "emailVerified": true,
    "avatar": "<string>"
  },
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "employeeCode": "<string>",
  "jobTitle": "<string>",
  "department": "<string>",
  "activatedAt": "2023-11-07T05:31:56Z",
  "suspendedAt": "2023-11-07T05:31:56Z",
  "revokedAt": "2023-11-07T05:31:56Z",
  "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.

Path Parameters

employeeId
string<uuid>
required

Employee identifier

Example:

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

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 employee payload

customerId
string<uuid> | null

Perfil de cliente/passageiro associado ao funcionário, quando existir

employeeCode
string | null

Código interno do funcionário na Company

jobTitle
string | null

Cargo informado pela Company

department
string | null

Departamento informado pela Company

status
enum<string>

Status do vínculo

Available options:
ACTIVE,
SUSPENDED,
REVOKED

Response

OK

Funcionário de uma Company vinculado a uma Membership

employeeId
string<uuid>
required

Identificador único

companyId
string<uuid>
required

Empresa dona do vínculo de funcionário

organizationId
string<uuid>
required

Organização da Company associada à Membership

membershipId
string<uuid>
required

Membership que originou o vínculo

membership
object
required

Basic membership data exposed with employee resources

userId
string<uuid>
required

Usuário vinculado à Membership

user
object
required

Basic user data exposed with employee resources

customerId
string<uuid> | null
required

Perfil de cliente/passageiro associado ao funcionário, quando existir

employeeCode
string | null
required

Código interno do funcionário na Company

jobTitle
string | null
required

Cargo informado pela Company

department
string | null
required

Departamento informado pela Company

status
enum<string>
required

Status do vínculo

Available options:
ACTIVE,
SUSPENDED,
REVOKED
activatedAt
string<date-time>
required

Data em que o vínculo ficou ativo

suspendedAt
string<date-time> | null
required

Data de suspensão do vínculo

revokedAt
string<date-time> | null
required

Data de revogação do vínculo

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 lógica