Update a Gateway

PUT /spaces/{spaceId}/gateways/{gatewayId}

Headers

  • Unique identifier for the API request. Example: f7ecf495-ca1c-4468-a6c2-6ee3f723fa00

Path parameters

  • spaceId string Required

    The identifier of the Space

  • gatewayId string Required

    The identifier of the Gateway

application/json

Body Required

  • isStatic boolean

    Indicate whether the Gateway is statically located. If so, then longitude and latitude are required.

  • latitude number(float)

    Latitude value of the coordinate. Example: 51.123

    Minimum value is -90, maximum value is 90.

  • rssiFilter string | integer(int32)

    The RSSI filter value for the Gateway BLE receiver (setting RSSI Filter via the API is only currently supported for Particle Gateways)

    One of:

    Values are FAR, NEAR, or VERY_NEAR.

    Minimum value is -127, maximum value is 0.

  • longitude number(float)

    Longitude value of the coordinate. Example: -0.123

    Minimum value is -180, maximum value is 180.

Responses

  • 200 application/json

    200 response

    Hide response attributes Show response attributes object
    • shortId string

      Short human-readable Gateway identifier. Example: 'AB1D'

      Maximum length is 10. Format should match the following pattern: ^[-_A-Za-z0-9]*$.

    • isStatic boolean

      Indicate whether the Gateway is statically located. If so, then longitude and latitude are required.

    • latitude number(float)

      Latitude value of the coordinate. Example: 51.123

      Minimum value is -90, maximum value is 90.

    • Indicate whether there are pending commands for the Gateway

    • rssiFilter string | integer(int32)

      The RSSI filter value for the Gateway BLE receiver (setting RSSI Filter via the API is only currently supported for Particle Gateways)

      One of:

      Values are FAR, NEAR, or VERY_NEAR.

      Minimum value is -127, maximum value is 0.

    • deviceId string

      Manufacturer identifier for the Gateway device. Example: 'e10fce301222e588e1d7482b'

      Maximum length is 100. Format should match the following pattern: ^[-_A-Za-z0-9]*$.

    • gatewayId string Required

      Gateway identifier, which is a combination of manufacturer and deviceId. Example: 'sysLoco_e10fce301222e588e1d7482b'

      Maximum length is 100. Format should match the following pattern: ^[-_A-Za-z0-9]*$.

    • Name of Gateway product. Example: 'HGD4'

      Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

    • addedOn string(date-time) Required

      ISO Timestamp of when the Gateway was linked, in UTC. Example: '2023-07-21T17:32:28Z'

      Maximum length is 20. Format should match the following pattern: ^[0-9TZ:-]*$.

    • Gateway manufacturer. Example: 'sysLoco'

      Maximum length is 100. Format should match the following pattern: ^[-_A-Za-z0-9]*$.

    • longitude number(float)

      Longitude value of the coordinate. Example: -0.123

      Minimum value is -180, maximum value is 180.

  • 401 application/json

    Unauthorized

    Hide response attribute Show response attribute object
    • errors array[object] Required
      Hide errors attributes Show errors attributes object
      • code string

        An application-specific error code, expressed as a string value

        Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

      • id string

        A unique identifier for this particular occurrence of the problem

        Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

      • detail string

        A human-readable explanation specific to this occurrence of the problem

        Maximum length is 500. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

      • title string

        A short, human-readable summary of the problem

        Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

      • status string

        The HTTP status code applicable to this problem, expressed as a string value

        Maximum length is 3. Format should match the following pattern: ^[0-9]*$.

  • 403 application/json

    Forbidden

    Hide response attribute Show response attribute object
    • errors array[object] Required
      Hide errors attributes Show errors attributes object
      • code string

        An application-specific error code, expressed as a string value

        Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

      • id string

        A unique identifier for this particular occurrence of the problem

        Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

      • detail string

        A human-readable explanation specific to this occurrence of the problem

        Maximum length is 500. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

      • title string

        A short, human-readable summary of the problem

        Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

      • status string

        The HTTP status code applicable to this problem, expressed as a string value

        Maximum length is 3. Format should match the following pattern: ^[0-9]*$.

  • 404 application/json

    Space or Gateway not found

    Hide response attribute Show response attribute object
    • errors array[object] Required
      Hide errors attributes Show errors attributes object
      • code string

        An application-specific error code, expressed as a string value

        Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

      • id string

        A unique identifier for this particular occurrence of the problem

        Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

      • detail string

        A human-readable explanation specific to this occurrence of the problem

        Maximum length is 500. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

      • title string

        A short, human-readable summary of the problem

        Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

      • status string

        The HTTP status code applicable to this problem, expressed as a string value

        Maximum length is 3. Format should match the following pattern: ^[0-9]*$.

  • 429 application/json

    Too Many Requests

    Hide response attribute Show response attribute object
    • errors array[object] Required
      Hide errors attributes Show errors attributes object
      • code string

        An application-specific error code, expressed as a string value

        Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

      • id string

        A unique identifier for this particular occurrence of the problem

        Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/"]*$`.

      • detail string

        A human-readable explanation specific to this occurrence of the problem

        Maximum length is 500. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

      • title string

        A short, human-readable summary of the problem

        Maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9!@#$&()\-.+,/" ]*$`.

      • status string

        The HTTP status code applicable to this problem, expressed as a string value

        Maximum length is 3. Format should match the following pattern: ^[0-9]*$.

PUT /spaces/{spaceId}/gateways/{gatewayId}
curl \
 --request PUT 'https://api.reelables.com/v1/spaces/{spaceId}/gateways/{gatewayId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "request-id: string" \
 --data '{"isStatic":true,"latitude":42.0,"rssiFilter":"FAR","longitude":42.0}'
Request examples
# Headers
request-id: string

# Payload
{
  "isStatic": true,
  "latitude": 42.0,
  "rssiFilter": "FAR",
  "longitude": 42.0
}
Response examples (200)
{
  "shortId": "string",
  "isStatic": true,
  "latitude": 42.0,
  "hasPendingCommands": true,
  "rssiFilter": "FAR",
  "deviceId": "string",
  "gatewayId": "string",
  "productName": "string",
  "addedOn": "2025-05-04T09:42:00Z",
  "manufacturer": "string",
  "longitude": 42.0
}
Response examples (401)
{
  "errors": [
    {
      "code": "string",
      "id": "string",
      "detail": "string",
      "title": "string",
      "status": "string"
    }
  ]
}
Response examples (403)
{
  "errors": [
    {
      "code": "string",
      "id": "string",
      "detail": "string",
      "title": "string",
      "status": "string"
    }
  ]
}
Response examples (404)
{
  "errors": [
    {
      "code": "string",
      "id": "string",
      "detail": "string",
      "title": "string",
      "status": "string"
    }
  ]
}
Response examples (429)
{
  "errors": [
    {
      "code": "string",
      "id": "string",
      "detail": "string",
      "title": "string",
      "status": "string"
    }
  ]
}