openapi: 3.2.0 info: title: Manage Push API configuration API version: 1.0.0 servers: - url: https://hq1.appsflyer.com/api/pushapi/v1.0/ security: - Bearer-Authentication: [] tags: - name: Manage Push API configuration paths: /app/{app-id}: get: tags: - Manage Push API configuration summary: Get Push API configuration description: '> ⚠️ Important > > All API V2 tokens generated before March 10, 2026, 19:00 UTC have been revoked. If your token was generated before this date, please regenerate it. [Learn how](https://support.appsflyer.com/hc/en-us/articles/360004562377-Managing-AppsFlyer-tokens). ' parameters: - name: app-id in: path description: Application ID example: id121244 required: true schema: type: string responses: '200': description: URL validated successfully headers: deprecated: description: is the api version deprecated? schema: type: boolean deprecationDate: description: deprecation date schema: type: string sunsetDate: description: sunset date schema: type: string deprecationMessage: description: deprecation message schema: type: string content: application/json: schema: type: object properties: endpoints: type: array items: anyOf: - $ref: '#/components/schemas/RegularAndroidConfig' - $ref: '#/components/schemas/RegularIosConfig' - $ref: '#/components/schemas/SkadConfig' '400': description: Invalid JSON format or no JSON found. Verify the content and resubmit. content: application/json: schema: $ref: '#/components/schemas/Error' '401': $ref: '#/components/responses/AuthenticationFailed' '402': description: Push API isn't part of your subscription. headers: deprecated: description: is the api version deprecated schema: type: boolean deprecationDate: description: deprecation date schema: type: string sunsetDate: description: sunset date schema: type: string deprecationMessage: description: deprecation message schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' examples: Missing Asset Push API: value: code: MissingAsset message: Push API isn't part of your subscription. Contact AppsFlyer support or your AppsFlyer account executive request_id: 8a3f4fa6-a91c-11ec-b909-0242ac120002 '403': description: Account problem occurred headers: deprecated: description: is the api version deprecated schema: type: boolean deprecationDate: description: deprecation date schema: type: string sunsetDate: description: sunset date schema: type: string deprecationMessage: description: deprecation message schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' examples: Account problem: value: code: AccountProblem message: An account problem ocurred. Please contact your AppsFlyer account executive. request_id: 8a3f4fa6-a91c-11ec-b909-0242ac120002 App ID not found: value: code: UnknownAppid message: The app ID specified wasn't found. Check that the app ID is identical to that in AppsFlyer in your account. request_id: 8a3f4fa6-a91c-11ec-b909-0242ac120002 '404': $ref: '#/components/responses/VersionDoesntExist' '410': $ref: '#/components/responses/VersionNoLongerValid' put: tags: - Manage Push API configuration summary: Update Push API configuration description: '> ⚠️ Important > > All API V2 tokens generated before March 10, 2026, 19:00 UTC have been revoked. If your token was generated before this date, please regenerate it. [Learn how](https://support.appsflyer.com/hc/en-us/articles/360004562377-Managing-AppsFlyer-tokens). ' parameters: - name: app-id in: path description: Application ID example: id121244 required: true schema: type: string requestBody: description: Body for validate URL content: application/json: schema: type: object properties: endpoints: type: array items: anyOf: - $ref: '#/components/schemas/RegularAndroidConfig' - $ref: '#/components/schemas/RegularIosConfig' - $ref: '#/components/schemas/SkadConfig' x-readme: explorer-enabled: false responses: '200': description: URL validated successfully headers: deprecated: description: is the api version deprecated? schema: type: boolean deprecationDate: description: deprecation date schema: type: string sunsetDate: description: sunset date schema: type: string deprecationMessage: description: deprecation message schema: type: string content: application/json: schema: type: object properties: request_id: type: string '400': description: JSON parsing error headers: deprecated: description: is the api version deprecated schema: type: boolean deprecationDate: description: deprecation date schema: type: string sunsetDate: description: sunset date schema: type: string deprecationMessage: description: deprecation message schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' example: code: InvalidPlatform message: An error occurred while parsing the JSON body. Check the body and try again.. requestId: 8a3f4fa6-a91c-11ec-b909-0242ac120002 '401': $ref: '#/components/responses/AuthenticationFailed' '402': description: Push API isn't part of your subscription. headers: deprecated: description: is the api version deprecated schema: type: boolean deprecationDate: description: deprecation date schema: type: string sunsetDate: description: sunset date schema: type: string deprecationMessage: description: deprecation message schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' examples: Missing Asset Event Type: value: code: MissingAsset message: The specified message type ({event-type} isn't part of your subscripton. Contact AppsFlyer support or your AppsFlyer account executive. request_id: 8a3f4fa6-a91c-11ec-b909-0242ac120002 Missing Asset Push API: value: code: MissingAsset message: Push API isn't part of your subscription. Contact AppsFlyer support or your AppsFlyer account executive request_id: 8a3f4fa6-a91c-11ec-b909-0242ac120002 '403': description: Account problem occurred headers: deprecated: description: is the api version deprecated schema: type: boolean deprecationDate: description: deprecation date schema: type: string sunsetDate: description: sunset date schema: type: string deprecationMessage: description: deprecation message schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' examples: Account problem: value: code: AccountProblem message: An account problem ocurred. Please contact your AppsFlyer account executive. request_id: 8a3f4fa6-a91c-11ec-b909-0242ac120002 App ID not found: value: code: UnknownAppid message: The app ID specified wasn't found. Check that the app ID is identical to that in AppsFlyer in your account. request_id: 8a3f4fa6-a91c-11ec-b909-0242ac120002 '404': $ref: '#/components/responses/VersionDoesntExist' '410': $ref: '#/components/responses/VersionNoLongerValid' '422': description: Schema Error headers: deprecated: description: is the api version deprecated schema: type: boolean deprecationDate: description: deprecation date schema: type: string sunsetDate: description: sunset date schema: type: string deprecationMessage: description: deprecation message schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' examples: Invalid JSON format: value: code: SchemaError message: Invalid JSON format or no JSON found. Verify the content and resubmit. request_id: 8a3f4fa6-a91c-11ec-b909-0242ac120002 Invalid message fields: value: code: InvalidMessageFields message: The selected_fields specified are not unique. Use unique selected_fields. request_id: 8a3f4fa6-a91c-11ec-b909-0242ac120002 Incorrect message fields: value: code: InvalidMessageFields message: Incorrect message-fields specified. request_id: 8a3f4fa6-a91c-11ec-b909-0242ac120002 Too many endpoints: value: code: TooManyEndpoints message: Too many endpoints. request_id: 8a3f4fa6-a91c-11ec-b909-0242ac120002 Missing mandatory fields: value: code: MissingMandatoryFields message: Every endpoint must include the mandatory selected_fields. request_id: 8a3f4fa6-a91c-11ec-b909-0242ac120002 Missing events: value: code: MissingEvents message: Every endpoint must include selected_inapps when an in-app event-type is selected. request_id: 8a3f4fa6-a91c-11ec-b909-0242ac120002 Missing event types: value: code: MissingEventTypes message: Every endpoint must include an in-app event-type when listing selected_inapps. request_id: 8a3f4fa6-a91c-11ec-b909-0242ac120002 Invalid URL: value: code: InvalidURL message: Invalid URL. request_id: 8a3f4fa6-a91c-11ec-b909-0242ac120002 Repeating URL: value: code: RepeatingURL message: Repeating URL. request_id: 8a3f4fa6-a91c-11ec-b909-0242ac120002 components: schemas: RegularIosConfig: title: Regular iOS Config type: object required: - url - method - attributing_entity - event_types - enabled properties: method: $ref: '#/components/schemas/Method' url: $ref: '#/components/schemas/Url' event_types: type: array items: enum: - organic-install-in-app-event - install - organic-install - re-engagement - re-attribution - reinstall - organic-reinstall - install-in-app-event - re-engagement-in-app-event - re-attribution-in-app-event selected_fields: oneOf: - type: string enum: - all title: All fields - type: string enum: - default title: Default fields - type: array title: Select fields items: enum: - api_version - af_c_id - campaign - af_adset_id - af_adset - af_ad_id - af_ad - af_ad_type - af_channel - af_cost_currency - af_cost_model - af_cost_value - af_keywords - af_attribution_lookback - af_prt - af_reengagement_window - af_siteid - af_sub_siteid - af_sub1 - af_sub2 - af_sub3 - af_sub4 - af_sub5 - is_retargeting - media_source - original_url - user_agent - advertising_id - android_id - amazon_aid - app_id - app_name - app_version - appsflyer_id - bundle_id - carrier - country_code - custom_data - customer_user_id - device_category - device_type - device_model - event_name - event_revenue - event_revenue_currency - event_time - event_value - idfa - idfv - imei - install_app_store - install_time - ip - language - operator - os_version - platform - sdk_version - wifi - gp_broadcast_referrer - city - attributed_touch_time - attributed_touch_type - contributor_1_af_prt - contributor_1_campaign - contributor_1_match_type - contributor_1_media_source - contributor_1_touch_time - contributor_1_touch_type - contributor_2_af_prt - contributor_2_campaign - contributor_2_match_type - contributor_2_media_source - contributor_2_touch_time - contributor_2_touch_type - contributor_3_af_prt - contributor_3_campaign - contributor_3_match_type - contributor_3_media_source - contributor_3_touch_time - contributor_3_touch_type - dma - event_revenue_usd - event_source - http_referrer - is_primary_attribution - is_receipt_validated - match_type - postal_code - region - retargeting_conversion_type - state - network_account_id - gp_click_time - gp_install_begin - gp_referrer - keyword_match_type - selected_currency - revenue_in_selected_currency - cost_in_selected_currency - attributed_touch_time_selected_timezone - install_time_selected_timezone - event_time_selected_timezone - selected_timezone - deeplink_url - oaid - keyword_id - store_reinstall - is_lat - device_download_time - device_download_time_selected_timezone - conversion_type - custom_dimension - campaign_type selected_inapps: oneOf: - type: string enum: - all title: All Inapps - type: array title: Select Inapps items: type: string enabled: type: boolean attributing_entity: type: string enum: - appsflyer default: appsflyer Error: example: code: SomeErrorCode message: Some error message. request_id: 8a3f4fa6-a91c-11ec-b909-0242ac120002 type: object properties: status: type: integer code: type: string message: type: string request_id: type: string Method: type: string enum: - '' - GET - POST Url: type: string maxLength: 2048 example: http://some.url.com:40/dir SkadConfig: title: SKADnetwork iOS Config type: object required: - url - method - attributing_entity - event_types - enabled properties: method: $ref: '#/components/schemas/Method' url: $ref: '#/components/schemas/Url' event_types: type: array items: enum: - install - re-download - in-app-event - postback - postbacks-copy enabled: type: boolean default: true attributing_entity: type: string enum: - skadnetwork default: skadnetwork RegularAndroidConfig: title: Regular Android Config type: object required: - url - method - attributing_entity - event_types - enabled properties: method: $ref: '#/components/schemas/Method' url: $ref: '#/components/schemas/Url' event_types: type: array items: enum: - organic-install-in-app-event - install - organic-install - re-engagement - re-attribution - reinstall - organic-reinstall - install-in-app-event - re-engagement-in-app-event - re-attribution-in-app-event selected_fields: oneOf: - type: string enum: - all title: All fields - type: string enum: - default title: Default fields - type: array title: Select fields items: enum: - api_version - af_c_id - campaign - af_adset_id - af_adset - af_ad_id - af_ad - af_ad_type - af_channel - af_cost_currency - af_cost_model - af_cost_value - af_keywords - af_attribution_lookback - af_prt - af_reengagement_window - af_siteid - af_sub_siteid - af_sub1 - af_sub2 - af_sub3 - af_sub4 - af_sub5 - is_retargeting - media_source - original_url - user_agent - advertising_id - android_id - amazon_aid - app_id - app_name - app_version - appsflyer_id - bundle_id - carrier - country_code - custom_data - customer_user_id - device_category - device_type - device_model - event_name - event_revenue - event_revenue_currency - event_time - event_value - idfa - idfv - imei - install_app_store - install_time - ip - language - operator - os_version - platform - sdk_version - wifi - gp_broadcast_referrer - city - attributed_touch_time - attributed_touch_type - contributor_1_af_prt - contributor_1_campaign - contributor_1_match_type - contributor_1_media_source - contributor_1_touch_time - contributor_1_touch_type - contributor_2_af_prt - contributor_2_campaign - contributor_2_match_type - contributor_2_media_source - contributor_2_touch_time - contributor_2_touch_type - contributor_3_af_prt - contributor_3_campaign - contributor_3_match_type - contributor_3_media_source - contributor_3_touch_time - contributor_3_touch_type - dma - event_revenue_usd - event_source - http_referrer - is_primary_attribution - is_receipt_validated - match_type - postal_code - region - retargeting_conversion_type - state - network_account_id - gp_click_time - gp_install_begin - gp_referrer - keyword_match_type - selected_currency - revenue_in_selected_currency - cost_in_selected_currency - attributed_touch_time_selected_timezone - install_time_selected_timezone - event_time_selected_timezone - selected_timezone - deeplink_url - oaid - keyword_id - store_reinstall - is_lat - device_download_time - device_download_time_selected_timezone - conversion_type - custom_dimension - campaign_type selected_inapps: oneOf: - type: string enum: - all title: All Inapps - type: array title: Select Inapps items: type: string enabled: type: boolean attributing_entity: type: string enum: - appsflyer default: appsflyer responses: VersionNoLongerValid: description: The API version listed in the URL is no longer valid headers: deprecated: description: is the api version deprecated schema: type: boolean deprecationDate: description: deprecation date schema: type: string sunsetDate: description: sunset date schema: type: string deprecationMessage: description: deprecation message schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' example: message: The API version listed in the URL is no longer valid. Check the API documentation AuthenticationFailed: description: Authentication failed. The authentication token is not valid. headers: deprecated: description: is the api version deprecated schema: type: boolean deprecationDate: description: deprecation date schema: type: string sunsetDate: description: sunset date schema: type: string deprecationMessage: description: deprecation message schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' VersionDoesntExist: description: The API version listed in the URL doesn't exist headers: deprecated: description: is the api version deprecated schema: type: boolean deprecationDate: description: deprecation date schema: type: string sunsetDate: description: sunset date schema: type: string deprecationMessage: description: deprecation message schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' example: code: InvalidVersion message: The API version listed in the URL doesn't exist. Check the API documentation request_id: 8a3f4fa6-a91c-11ec-b909-0242ac120002 securitySchemes: Bearer-Authentication: type: http scheme: bearer description: "**Important: API V2 Token Revocation**\n\nAll API V2 tokens generated before March 10, 2026, 19:00 UTC have been revoked. If your token was generated before this date, please regenerate it. [Learn how](https://support.appsflyer.com/hc/en-us/articles/360004562377-Managing-AppsFlyer-tokens).\n\nAuthorization HTTP header containing API V2 token (bearer token) is required.\n\n The admin [gets the V2 token in the dashboard](https://support.appsflyer.com/hc/en-us/articles/360004562377) "