--- title: "Rename, transfer, or manage tunneling for a SIM" method: PUT path: "/devices/{deviceId}" tags: ["SIMs (Devices)"] --- # Rename, transfer, or manage tunneling for a SIM `PUT /devices/{deviceId}` ## Request - Base URL: `https://dashboard.hologram.io/api/1` - URL: `https://dashboard.hologram.io/api/1/devices/{deviceId}` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Updates the specified SIM by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This endpoint allows you to rename a SIM/device, transfer ownership of the SIM to a different organization, and enable or disable secure device tunneling with Spacebridge. ## Path parameters - `deviceId` integer, required ## Request body - object - `name` string: New device name - `orgid` integer: Transfer device to this organization - `tunnelable` boolean: Enable or disable SpaceBridge tunneling for the device ## Response `200` OK - GetDeviceResponse - `success` boolean: Indicates whether the request was successful. - `data` DeviceObject - `id` integer: Unique device ID - `name` string: Device name - `orgid` integer: Organization ID - `type` string: Device type - `whencreated` string: Device creation timestamp (UTC) - `tags` string[]: Tags associated with this device - `links` object - `cellular` CellularLinkInDevice[] - `id` integer: Cellular link ID - `deviceid` integer: Device ID - `orgid` integer: Organization ID - `sim` string: ICCID of the SIM's enabled profile - `msisdn` string: Phone number assigned to this SIM - `imsi` integer: International Mobile Subscriber Identity - `state` 'INACTIVE' | 'INACTIVE-TESTED' | 'FACTORY-PENDING' | 'FACTORY' | 'LIVE-PENDING' | 'LIVE' | 'FROZEN' | 'FROZEN-PENDING' | 'DEAD' | 'DEAD-PENDING' | 'PAUSED-SYS' | 'PAUSED-PENDING-SYS' | 'PAUSED-USER' | 'PAUSED-PENDING-USER' | 'TEST-ACTIVATE' | 'TEST-ACTIVATE-PENDING' | 'TEST-AUTOACTIVATE' | 'TEST-AUTOACTIVATE-PENDING' | 'TEST-HIBERNATE' | 'TEST-HIBERNATE-PENDING' - `profile_state` 'AVAILABLE' | 'DOWNLOAD_PENDING' | 'DOWNLOADED' | 'ENABLE_PENDING' | 'ENABLED' | 'DISABLE_PENDING' | 'DISABLED' | 'DELETE_PENDING' | 'ASSIGNED' | 'UNAVAILABLE' - `profile_name` string, nullable: Carrier display name for this profile - `apn` string: Access Point Name - `zone` integer: Data plan coverage zone - `overagelimit` integer: Additional bytes of data allowed above the plan's included data; SIM pauses when usage exceeds plan included data plus this value (-1 for unlimited, 0 for plan included data only) - `carrier` integer: Carrier backend ID - `whencreated` string: SIM activation timestamp (UTC) - `whenexpires` string: SIM expiry timestamp (UTC) - `rsp_type_id` integer, nullable: RSP (Remote SIM Provisioning) type ID for this profile - `rsp_type_display_name` string, nullable: Customer-facing name of this profile's RSP type - `euicc_spec` 'Not supported' | 'SGP.02' | 'SGP.22' | 'SGP.32' | 'Unknown': eUICC specification supported by an RSP type - `async_change_requests` AsyncChangeRequestObject[]: Non-terminal async change requests associated with this cellular link - `id` integer: Async change request ID - `parent_id` integer, nullable: Parent request ID for child requests - `orgid` integer, nullable: Organization ID - `userid` integer, nullable: User ID who initiated the request - `request_type` 'plan_change' | 'euicc_audit' | 'sim_configuration_update' | 'configure_sim' | 'sim_state_pause' | 'sim_state_unpause' | 'sim_state_activation': Type of async change request - `reference_type` 'device' | 'link' | 'simcard' | 'sim_configuration': Type of the referenced object - `reference_id` integer: ID of the referenced object - `state` 'initialized' | 'in_progress': Current state of the request - `start_time` string: Timestamp when the request was created (UTC) - `update_time` string: Timestamp of the last state update (UTC) - `metadata` object, nullable: Request-type-specific metadata - `eid` string, nullable: EID of the sim card, may be null for some sim card types - `imei` string: IMEI of the device - `imei_sv` string: IMEI Software Version (IMEISV) of the device - `tunnelable` 0 | 1: 1 if the device supports secure tunneling with Spacebridge - `hidden` 0 | 1: 1 if the device is hidden on the Dashboard - `phonenumber` string: Phone number assigned to the SIM, empty string if none - `phonenumber_cost` string: Monthly cost of the assigned phone number - `simcardid` integer: SIM card ID associated with the device - `intended_network_state` 'INACTIVE' | 'INACTIVE-TESTED' | 'FACTORY-PENDING' | 'FACTORY' | 'LIVE-PENDING' | 'LIVE' | 'FROZEN' | 'FROZEN-PENDING' | 'DEAD' | 'DEAD-PENDING' | 'PAUSED-SYS' | 'PAUSED-PENDING-SYS' | 'PAUSED-USER' | 'PAUSED-PENDING-USER' | 'TEST-ACTIVATE' | 'TEST-ACTIVATE-PENDING' | 'TEST-AUTOACTIVATE' | 'TEST-AUTOACTIVATE-PENDING' | 'TEST-HIBERNATE' | 'TEST-HIBERNATE-PENDING' - `intended_plan_id` integer, nullable: Intended data plan ID for the SIM - `intended_zone` string, nullable: Intended plan zone for the SIM - `intended_plan_name` string, nullable: Name of the SIM's intended data plan - `intended_plan_data` integer, nullable: Included data (bytes) on the SIM's intended data plan - `rsp_type_id` integer, nullable: RSP (Remote SIM Provisioning) type ID for the SIM, from simcards.rsp_type_id - `rsp_type_display_name` string, nullable: Customer-facing name of the SIM's RSP type, from rsp_types.display_name - `euicc_spec` 'Not supported' | 'SGP.02' | 'SGP.22' | 'SGP.32' | 'Unknown': eUICC specification supported by an RSP type - `sim_format` string, nullable: Physical SIM form factor from simcards.metadata.form_factor, e.g. tricut, embedded, eSIM - `whenclaimed` string, nullable: SIM activation timestamp from simcards.when_claimed (UTC) - `euicc_tested` string: eUICC test status for the device - `is_hyper` boolean: True if the device is a Hyper SIM and supports eUICC rather than a standard UICC SIM - `model` string: Device model derived from IMEI TAC lookup, "Unknown" if not found - `manufacturer` string: Device manufacturer derived from IMEI TAC lookup, "Unknown" if not found - `preflight_starttime` string, nullable: Timestamp (UTC) when the SIM entered Test Mode, null if not in Test Mode - `preflight_scheduled_endtime` string, nullable: Timestamp (UTC) when the SIM is scheduled to exit Test Mode, null if not in Test Mode - `async_change_requests` AsyncChangeRequestObject[]: Non-terminal async change requests associated with this device - `id` integer: Async change request ID - `parent_id` integer, nullable: Parent request ID for child requests - `orgid` integer, nullable: Organization ID - `userid` integer, nullable: User ID who initiated the request - `request_type` 'plan_change' | 'euicc_audit' | 'sim_configuration_update' | 'configure_sim' | 'sim_state_pause' | 'sim_state_unpause' | 'sim_state_activation': Type of async change request - `reference_type` 'device' | 'link' | 'simcard' | 'sim_configuration': Type of the referenced object - `reference_id` integer: ID of the referenced object - `state` 'initialized' | 'in_progress': Current state of the request - `start_time` string: Timestamp when the request was created (UTC) - `update_time` string: Timestamp of the last state update (UTC) - `metadata` object, nullable: Request-type-specific metadata ## Other responses - `401`: Unauthorized --- [API](https://skmtc.dev/hologram/apis/hologram-rest-api-v1.md) - [All operations](https://skmtc.dev/hologram/apis/hologram-rest-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/hologram/apis/hologram-rest-api-v1/revisions/1bc07dcd1631?raw)