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

# Update users by email

> Update user external IDs by email. Matches users in your organization by
email and assigns each an externalId for use in subsequent API calls
(e.g., load sync coverage assignment).



## OpenAPI

````yaml /openapi.yml post /users/updateByEmail
openapi: 3.1.0
info:
  title: Cargado API
  version: 1.0.0
  description: Cargado's API
  termsOfService: https://cargado.com/terms/
  contact:
    email: dev-support@cargado.com
servers:
  - url: https://api.cargado.com
    description: The production Cargado API server
security: []
tags:
  - name: Border Crossings
  - name: Loads
  - name: Rates
  - name: CarrierRelationship
  - name: User
  - name: Team
  - name: Webhooks
  - name: Bids
paths:
  /users/updateByEmail:
    post:
      tags:
        - User
      summary: Update users by email
      description: |-
        Update user external IDs by email. Matches users in your organization by
        email and assigns each an externalId for use in subsequent API calls
        (e.g., load sync coverage assignment).
      operationId: UpdateUsersByEmail
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUpdateByEmailInput'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserUpdateByEmailOutput'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                required:
                  - message
                type: object
              examples:
                Example 1:
                  value:
                    message: Unauthorized
      security:
        - apiKey: []
components:
  schemas:
    UserUpdateByEmailInput:
      properties:
        users:
          items:
            $ref: '#/components/schemas/UserUpdateByEmailItemInput'
          type: array
      required:
        - users
      type: object
      additionalProperties: true
    UserUpdateByEmailOutput:
      properties:
        results:
          items:
            $ref: '#/components/schemas/UserUpdateByEmailItemResult'
          type: array
      required:
        - results
      type: object
      additionalProperties: true
    UserUpdateByEmailItemInput:
      properties:
        email:
          type: string
          minLength: 1
        externalId:
          type: string
          minLength: 1
      required:
        - email
        - externalId
      type: object
      additionalProperties: true
    UserUpdateByEmailItemResult:
      anyOf:
        - $ref: '#/components/schemas/UserUpdateByEmailMatch'
        - $ref: '#/components/schemas/UserUpdateByEmailNotFound'
        - $ref: '#/components/schemas/UserUpdateByEmailDuplicate'
    UserUpdateByEmailMatch:
      properties:
        status:
          type:
            - string
            - 'null'
          enum:
            - MATCHED
        email:
          type: string
        id:
          type: string
          examples:
            - usr_abc123
        externalId:
          type: string
          examples:
            - ext-1
      required:
        - status
        - email
        - id
        - externalId
      type: object
      additionalProperties: true
    UserUpdateByEmailNotFound:
      properties:
        status:
          type:
            - string
            - 'null'
          enum:
            - NOT_FOUND
        email:
          type: string
      required:
        - status
        - email
      type: object
      additionalProperties: true
    UserUpdateByEmailDuplicate:
      properties:
        status:
          type:
            - string
            - 'null'
          enum:
            - DUPLICATE
        email:
          type: string
      required:
        - status
        - email
      type: object
      additionalProperties: true
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: api-key

````