IotHub TALQ
  1. Devices
IotHub TALQ
  • API
    • Guia
      • Vendor
        • Create a Guia Vendor
        • List Guia Vendors
        • Modify a Guia Vendor
        • Modify a Guia Photo Vendor
      • Devices
        • List Guia Devices
          GET
        • Get a Guia Device
          GET
        • Get a Guia Device Attribute History
          GET
        • List Guia Gateways
          GET
        • Modify devices
          PATCH
        • Modify device
          PATCH
        • Modify device function
          PATCH
        • Modify device - Set External Id
          PATCH
        • Modify device function attribute
          PATCH
        • Modify a Guia Change Asset Device
          PATCH
        • Create a Guia Device From Identified Material
          POST
        • Create a Guia Device Multiple From Identified Material
          POST
      • Device classes
        • List Guia Device Classes
        • Get a Guia Device Class
        • List Guia Device Class Functions
      • Functions
        • List Guia Functions
        • List Guia Function Attributes
        • List Guia Function Types
      • Attributes
        • List Guia Attributes get
        • List Guia Function Attributes
      • Groups
        • Create a Guia Group
        • List Guia Groups
        • Get a Guia Group
        • Get Count
        • Get a Guia Group Member Count
        • Update Groups
        • Update a Guia Group
        • Update a Guia Group Member
        • Delete a Guia Group
        • Delete a Guia Group Member
    • TALQ
      • Device Class
        • Create a Talq Device Class
        • Update Talq Device Class
        • Delete a Talq Device Class
        • Update a Talq Device Class
      • Device
        • Create a Talq Device
        • List Talq Devices
        • Modify a Talq Device
        • Update Talq Devices
        • Delete a Talq Device
        • Get a Talq Device
        • Modify a Talq Device patch
        • Update a Talq Device
        • Get a Talq Device Function
        • Get a Talq Device Attribute
      • Services
        • Create a Talq Service
      • Group
        • List Talq Groups
        • Get a Talq Group
    • Google Pub
      • Sub
        • List Pubsub Failed Messages
        • Get a Pubsub Failed Message
        • Delete a Pubsub Failed Message
        • Create a Pubsub Guia Device Multiple Devices Partial Update
        • Create a Pubsub Guia Device Partial Device Update
        • Create a Pubsub Guia Device Attribute Value Update
        • Create a Pubsub Guia Device Function Update
        • Create a Pubsub Guia Device Set External Id
        • Create a Pubsub Vendor Dispatcher Dispatch
    • Clients
      • Create a Client
      • Modify a Client Synchronize
    • Vendors
      • Create a Vendor
      • List Vendors
      • Create a Vendor Client Service Cod
      • Get a Vendor Client Service Cod
      • Delete a Vendor Client Service Cod
    • Health Check
      • List Health
  • Docs TALQ
    • Processo de Inicialização - Bootstrap Process
    • API GUIA
    • Tratamento de Erros
    • Configurações da instância
    • Sobreposição de comandos
  • Docs TALQ
    • Introdução à especificação TALQ
    • Visão geral da API TALQ
  1. Devices

Modify device - Set External Id

PATCH
/guia/devices/{deviceUuid}/setExternalId
Updates the specified device external_id.

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Path Params

Header Params

Body Params application/json

Example
{
    "externalId": "abc123a"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request PATCH 'https://iot.exati.com.br/staging/guia/devices/{{device-uuid}}/setExternalId' \
--header 'x-guia-uuid;' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "externalId": "abc123a"
}'

Responses

🟢200OK
Device external id updated successfully
This response does not have a body.
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
🟠409409
🟠422Parameter Error
Modified at 2025-07-31 10:06:38
Previous
Modify device function
Next
Modify device function attribute