Update an external user

QA Environment

https://qa-api.kiolinkapp.com

PATCH

/v1/kiolink/external-user/{id}

External Users

Last modified:2026-10-05 21:09:41

Maintainer:Not configured

Required Permission(s):staff-external-update

Updates an external user with the fields sent. email is required on every update and must have a valid format.

The email deliverability check runs but its result is discarded, so verify_email keeps its old value. An ID that does not exist returns HTTP 200 with an empty body.

Used by the Staff module. Behaves exactly like Edit an external user; only the required permission differs.

Requires a session token whose role has the staff-external-update permission.

Request

Authorization

API Key

Add parameter in header

authorization

Example:

authorization: ********************

Path Params

Body Params application/jsonRequired

Example

{
  "email": "carlos.ruiz@proveedor.com",
  "cel": "5598765432"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://qa-api.kiolinkapp.com/v1/kiolink/external-user/65f1c2a9e4b0a1b2c3d4e5f1' \
--header 'authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "email": "carlos.ruiz@proveedor.com",
  "cel": "5598765432"
}'

Responses

🟢200The updated user, or an empty body if it does not exist

application/json

The updated user, or an empty body if it does not exist.

Bodyapplication/json

Example

{
    "_id": "65f1c2a9e4b0a1b2c3d4e5f1",
    "email": "carlos.ruiz@proveedor.com",
    "name": "Carlos Ruiz",
    "cel": "5598765432",
    "company": "Proveedor SA de CV",
    "avatar": "",
    "devices": [
        {
            "_id": "65f1c2a9e4b0a1b2c3d4e603",
            "brand": "Dell",
            "model": "Latitude 7440",
            "series": "CN0ABC123"
        }
    ],
    "created_at": "2025-04-02T17:30:00.000Z",
    "verify_email": "deliverable",
    "__v": 0
}

🟠400`email` is missing or has an invalid format

🟠401The session token expired

🟠403Not authenticated (missing/invalid token, inactive user), or

🔴500Unexpected error (e

Modified at 2026-10-05 21:09:41

Edit an external user

Upload an external user's avatar