Error Codes (REST API)

A description of the error codes you might encounter while working with our REST API.

This error code will be returned when a User-Linking REST API request tries to link an active install_id to an existing external_id which already has a linked install_id.

This primarily happens when legacy users, who were first created before user linking was introduced in the app, are switching to a new device. Because they were created before user linking was introduced, they got 'hardlinked' to the initial install id. As a result, they cannot be linked to a new device. To resolve this, create a new user under a different Sentiance id.

INSTALL_NOT_FOUND

This error code will be returned when the given install_id cannot be found in a User-Linking REST API request.

INSTALL_DOES_NOT_BELONG_TO_APP

This error code will be returned when the given install_id's app_id doesn't match the given app_id in a User-Linking REST API request.

Make sure you've used the right app_id. Most clients use multiple environments (production, staging, development, ...). Make sure you are using the app_id belonging to the right environment. These are not interchangeable.

INSTALL_DISABLED

This error code will be returned when the given install_id is found to be disabled by the platform in a User-Linking REST API request.

INSTALL_DELETED

This error code will be returned when the given install_id is found to be deleted by the platform in a User-Linking REST API request.

INSTALL_DEACTIVATED

This error code will be returned when the given install_id is already linked and is no longer active in a User-Linking REST API request.

INSTALL_LINKED_TO_OTHER_USER

This error code will be returned when the given install_id is found to have a linked external_id while this linked external_id doesn't match the given external_id in a User-Linking REST API request.

MULTIPLE_INSTALLS_ACTIVE

This error code will be returned when there are two or more active install_ids found in the platform by the given external_id in a User-Linking REST API request.

USERLINKING_NOT_CONFIGURED

This error code will be returned when the app is found to not have user-linking enabled in a User-Linking REST API request.

For most apps, User Linking will be turned on by default. If this is not the case for your app, please reach out to Support and they'll set things up for you.

USER_DOES_NOT_BELONG_TO_APP

This error code will be returned when the app_id of the given users doesn't match the given app_id in a Custom-Event REST API request.

USER_NOT_FOUND

This error code will be returned when any of the given users cannot be found in the platform in a Custom-Event REST API request.

Make sure you've used the right Sentiance id. Most of our REST API queries expect to receive the Sentiance ID, not your external ID.