Update Platform Context

Change a platform context's ID

Use this endpoint to change the ID that identifies one of your Contexts.

This should be used primarily for migration, if the IDs in your application (and particularly the IDs on your tokens) change.

Note that calling this endpoint while a user is active on Xkit could potentially cause issues:

  • if the new Context ID already exists, this call will fail
  • if the user is logged in during the migration, they may inadvertently recreate a Context under their old ID
Path Params
string
required

The unique user identifier for the platform user provided to Xkit when the user was provisioned.

Body Params
context
object

The desired updated parameters of the context, including its new external_id

Responses

Language
Credentials
Basic
base64
:
Request
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json