> ## Documentation Index
> Fetch the complete documentation index at: https://docs.salvy.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Sincronizar colaboradores em lote

> Cria ou atualiza vários colaboradores de uma vez, identificados pelo `integrationId` de sua escolha. A requisição é aceita por inteiro ou recusada por inteiro: se algum colaborador for inválido, nenhum é alterado e a resposta aponta a posição dele na lista. Os colaboradores são sincronizados em segundo plano; a resposta traz o ID de uma tarefa para acompanhar o resultado em GET /tasks/{id}.



## OpenAPI

````yaml api-reference/v3/openapi.json POST /api/v3/employees/batch-sync
openapi: 3.1.0
info:
  version: v3
  title: Salvy API
  x-logo:
    url: web/logo.png
servers:
  - url: https://api.salvy.com.br
    description: Salvy API URL
security:
  - bearerAuth: []
tags:
  - name: Public API
  - name: Outgoing Webhooks
paths:
  /api/v3/employees/batch-sync:
    post:
      tags:
        - Public API
      description: >-
        Cria ou atualiza vários colaboradores de uma vez, identificados pelo
        `integrationId` de sua escolha. A requisição é aceita por inteiro ou
        recusada por inteiro: se algum colaborador for inválido, nenhum é
        alterado e a resposta aponta a posição dele na lista. Os colaboradores
        são sincronizados em segundo plano; a resposta traz o ID de uma tarefa
        para acompanhar o resultado em GET /tasks/{id}.
      operationId: publicBatchSyncEmployeesV3
      parameters:
        - name: idempotency-key
          in: header
          required: false
          schema:
            $schema: https://json-schema.org/draft/2020-12/schema
            description: >-
              Idempotency key for this request. Will return the same response if
              the same request is made again with the same key. Fails if
              parameters are different.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                employees:
                  minItems: 1
                  maxItems: 1000
                  type: array
                  items:
                    type: object
                    properties:
                      integrationId:
                        type: string
                        minLength: 1
                        description: >-
                          Identificador único de sua escolha para esse
                          colaborador. Um colaborador já sincronizado com o
                          mesmo identificador é atualizado; senão, um novo é
                          criado.
                        example: '123'
                      forceCreate:
                        description: >-
                          Quando `true`, ignora a busca por colaboradores
                          existentes (por `integrationId`, `cpf`, `workEmail` e
                          `fullName`) e cria um novo colaborador. Útil para
                          cadastrar intencionalmente um colaborador duplicado.
                        example: false
                        type: boolean
                      fullName:
                        type: string
                        minLength: 1
                        description: Nome completo
                        example: João da Silva
                      socialName:
                        description: Nome social
                        example: João
                        type: string
                      status:
                        type: string
                        enum:
                          - active
                          - terminated
                          - on-hold
                        description: Situação do colaborador
                        example: active
                      workEmail:
                        description: E-mail profissional
                        example: joaosilva@empresa.com.br
                        type: string
                      personalEmail:
                        description: E-mail pessoal
                        example: joaos04@gmail.com
                        type: string
                      workPhoneNumber:
                        description: Telefone profissional
                        example: '+5541923456789'
                        type: string
                      personalPhoneNumber:
                        description: Telefone pessoal
                        example: '+5541987654321'
                        type: string
                      cpf:
                        description: Número do CPF
                        example: 198.099.750-07
                        type: string
                      position:
                        description: Cargo do colaborador
                        example: Desenvolvedor
                        type: string
                      area:
                        description: Área do colaborador
                        example: Engenharia
                        type: string
                      managerFullName:
                        description: Nome do gestor
                        example: Maria dos Santos
                        type: string
                      birthDate:
                        description: Data de nascimento
                        example: '1990-04-15'
                        type: string
                      admittedAt:
                        description: Data de admissão
                        example: '2020-05-27'
                        type: string
                      terminatedAt:
                        description: Data de desligamento
                        example: '2021-01-20'
                        type: string
                      address:
                        description: Endereço do colaborador
                        type: object
                        properties:
                          zipCode:
                            description: CEP
                            example: 12345-678
                            type: string
                          streetName:
                            description: Nome da rua
                            example: Rua das Flores
                            type: string
                          streetNumber:
                            description: Número da casa
                            example: '123'
                            type: string
                          complement:
                            description: Complemento do endereço
                            example: Apto 101
                            type: string
                          neighborhood:
                            description: Bairro
                            example: Jardim das Flores
                            type: string
                          city:
                            description: Cidade
                            example: São Paulo
                            type: string
                          state:
                            description: Estado
                            example: SP
                            type: string
                          country:
                            description: País
                            example: Brasil
                            type: string
                    required:
                      - integrationId
                      - fullName
                      - status
                  description: >-
                    Colaboradores a criar ou atualizar, até 1.000 por
                    requisição, cada um com um `integrationId` diferente. O
                    corpo da requisição é limitado a 1 MB; se a sua base passar
                    disso, divida-a em mais de uma requisição.
              required:
                - employees
              additionalProperties: false
        required: true
      responses:
        '202':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  taskId:
                    type: string
                    format: uuid
                    pattern: >-
                      ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                    description: >-
                      ID da tarefa que sincroniza os colaboradores; acompanhe o
                      resultado em GET /tasks/{id}.
                    example: 0f9c1b2e-5d3a-4f8b-9c7e-1a2b3c4d5e6f
                required:
                  - taskId
                additionalProperties: false
        '400':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - idempotency-parameters-mismatch-error
                      - idempotency-invalid-header-error
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - unauthorized
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '403':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - forbidden
                      - insufficient-scope
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - resource-not-found
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '413':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - payload-too-large
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '422':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - input-validation-error
                      - unprocessable-entity
                      - company-not-active
                  message:
                    type: string
                  details:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        message:
                          type: string
                      required:
                        - key
                        - message
                      additionalProperties: false
                required:
                  - code
                  - message
                additionalProperties: {}
        '429':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - too-many-attempts
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - unknown
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
      deprecated: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.