I struggled with finding an example of this as well. If you call the GET endpoint for an existing app clip experience with extra parameters, it will give you examples of what the data should look like. To get your experience UID, go to the experience in app store connect and get the UID from your browser's address bar. Your request should look something like this:
https://api.appstoreconnect.apple.com/v1/appClipAdvancedExperiences/[your_appclip_experience_id]?include=headerImage,localizations,appClip
This will give you an idea of what the appclip, headerImage, and localization data should look like. Note you'll get a lot of fields in a GET response that you don't need to use when creating a new experience. If you look at the documentation it'll tell you which ones you need to keep.
the app clip reference can be found in the GET response for your experience
the header image must be uploaded separately in 2 steps and referenced in your request, see here. Once the upload is successful grab the id for that image and use that in your app clip creation request
the localization (you need at least 1) must be declared in the "included" section of the request's body.
Here's an example request body for an advanced experience to POST to https://api.appstoreconnect.apple.com/v1/appClipAdvancedExperiences
{
"data": {
"type": "appClipAdvancedExperiences",
"attributes": {
"link": "https://www.yourdomain.com/appclip123",
"action": "VIEW",
"isPoweredBy": true,
"businessCategory": "AUTOMOTIVE",
"defaultLanguage": "EN"
},
"relationships": {
"appClip": {
"data": {
"type": "appClips",
"id": "your_appclip_uid"
}
},
"headerImage": {
"data": {
"type": "appClipAdvancedExperienceImages",
"id": "your_header_image_uid"
}
},
"localizations": {
"meta": {
"paging": {
"total": 1,
"limit": 10
}
},
"data": [{
"type": "appClipAdvancedExperienceLocalizations",
"id": "EN"
}]
}
}
},
"included": [
{
"type": "appClipAdvancedExperienceLocalizations",
"id": "EN",
"attributes": {
"language": "EN",
"title": "Your title",
"subtitle": "Your subtitle"
}
}
]
}
Topic:
App & System Services
SubTopic:
General
Tags: