POST /api/v2/server-side-api/integration/profile/set/integration-identifiers/

Set integration identifiers

Adds integration identifiers to a profile.

Header parameters

adapty-customer-user-idstring

The unique ID of the customer in your system. Either adapty-customer-user-id or adapty-profile-id is required.

adapty-profile-idstring · uuid

The unique ID of the profile in your system. Your best option if you are working with anonymous profiles. Either adapty-customer-user-id or adapty-profile-id is required.

Request body

At least one integration identifier must be provided

adjust_device_idstring

The network user's ID in the Adjust integration

airbridge_device_idstring

The ID of the user's device in Airbridge integration

amplitude_device_idstring

The ID of the user's device in Amplitude integration

amplitude_user_idstring

The ID of the user in Amplitude integration

appmetrica_device_idstring

The ID of the user's device in AppMetrica integration

appmetrica_profile_idstring

The ID of the user in AppMetrica integration

appsflyer_idstring

The network user's ID in the AppsFlyer integration

branch_idstring

The Branch Key of the user's app in the Branch integration

facebook_anonymous_idstring

The ID of the user in Facebook Ads integration

firebase_app_instance_idstring

The ID of the user in Firebase integration

mixpanel_user_idstring

The ID of the user in Mixpanel integration

one_signal_player_idstring

The ID of the user in OneSignal integration (Legacy identifier)

one_signal_subscription_idstring

The ID of the user in OneSignal integration (Recommended identifier)

posthog_distinct_user_idstring

The ID of the user in PostHog integration

pushwoosh_hwidstring

The ID of the user's device in Pushwoosh integration

tenjin_analytics_installation_idstring

The ID of the user's device in Tenjin integration

Responses

Integration identifiers set successfully. The response body is blank.

Bad request

Schema
errorsarray of objectrequired
sourcestring

Source of the error

errorsarray of string

Array of error messages

error_codestringrequired

Short error name

status_codeintegerrequired

HTTP status code

Example
{
  "errors": [
    "At least one integration identifier must be provided."
  ],
  "error_code": "validation_error",
  "status_code": 400
}

Unauthorized

Schema
errorsarray of objectrequired
sourcestring

Source of the error

errorsarray of string

Array of error messages

error_codestringrequired

Short error name

status_codeintegerrequired

HTTP status code

Example
{
  "errors": [
    "Invalid API key"
  ],
  "error_code": "unauthorized",
  "status_code": 401
}

Profile not found

Schema
errorsarray of objectrequired
sourcestring

Source of the error

errorsarray of string

Array of error messages

error_codestringrequired

Short error name

status_codeintegerrequired

HTTP status code

Example
{
  "errors": [
    "Profile not found"
  ],
  "error_code": "profile_not_found",
  "status_code": 404
}

Internal server error

Schema
errorsarray of objectrequired
sourcestring

Source of the error

errorsarray of string

Array of error messages

error_codestringrequired

Short error name

status_codeintegerrequired

HTTP status code