Skip to main content

Partial Update Device

PATCH 
/v1/:clientId/user-devices/:deviceId

Use this to update an existing device.

You can update any field from the "Create Device" request except for the deviceId and authId.

Any tags or associatedIds included in this request are merged with existing tags, overwriting any existing tags with the same name.

Tags which have been added by a backend system cannot be modified via this endpoint.

Note: this endpoint can be used without having to first call the "Create Device" endpoint. If the deviceId doesn't currently exist on the server then a new device will be created automatically. Similar to the "Create Device" endpoint, if an access token is included as a header in the request then the authId will be extracted automatically.

Request​

Path Parameters

    clientId stringrequired
    deviceId stringrequired

Header Parameters

    X-API-KEY string
    Example: bsKXkZhhdczuaHZ4xwVGk47Mbm77Epcf
    X-REALM string
    Example: incrowd
    X-APP-ID string
    Example: ios
    Authorization string

    [Optional] InCrowd access token

    Example: Bearer {{access_token}}

Body

    object

Responses​

OK

Response Headers

  • Content-Type

    string

  • Content-Length

    integer

  • Connection

    string

  • Vary

    string

  • Date

    string

  • X-Cache

    string

  • Via

    string

  • X-Amz-Cf-Pop

    string

  • X-Amz-Cf-Id

    string

Schema

    object

Loading...