App Clips
Endpoints for managing App Clips and default experiences.
Endpoints
POST /v1/appClipAdvancedExperienceImages
Summary: No summary provided.
GET /v1/appClipAdvancedExperienceImages/{id}
Summary: No summary provided.
Parameters:
fields[appClipAdvancedExperienceImages] (query, optional): the fields to include for returned resources of type appClipAdvancedExperienceImages
PATCH /v1/appClipAdvancedExperienceImages/{id}
Summary: No summary provided.
POST /v1/appClipAdvancedExperiences
Summary: No summary provided.
GET /v1/appClipAdvancedExperiences/{id}
Summary: No summary provided.
Parameters:
fields[appClipAdvancedExperiences] (query, optional): the fields to include for returned resources of type appClipAdvancedExperiencesfields[appClips] (query, optional): the fields to include for returned resources of type appClipsfields[appClipAdvancedExperienceImages] (query, optional): the fields to include for returned resources of type appClipAdvancedExperienceImagesfields[appClipAdvancedExperienceLocalizations] (query, optional): the fields to include for returned resources of type appClipAdvancedExperienceLocalizationsinclude (query, optional): comma-separated list of relationships to includelimit[localizations] (query, optional): maximum number of related localizations returned (when they are included)
PATCH /v1/appClipAdvancedExperiences/{id}
Summary: No summary provided.
POST /v1/appClipAppStoreReviewDetails
Summary: No summary provided.
GET /v1/appClipAppStoreReviewDetails/{id}
Summary: No summary provided.
Parameters:
fields[appClipAppStoreReviewDetails] (query, optional): the fields to include for returned resources of type appClipAppStoreReviewDetailsfields[appClipDefaultExperiences] (query, optional): the fields to include for returned resources of type appClipDefaultExperiencesinclude (query, optional): comma-separated list of relationships to include
PATCH /v1/appClipAppStoreReviewDetails/{id}
Summary: No summary provided.
POST /v1/appClipDefaultExperienceLocalizations
Summary: No summary provided.
GET /v1/appClipDefaultExperienceLocalizations/{id}
Summary: No summary provided.
Parameters:
fields[appClipDefaultExperienceLocalizations] (query, optional): the fields to include for returned resources of type appClipDefaultExperienceLocalizationsfields[appClipDefaultExperiences] (query, optional): the fields to include for returned resources of type appClipDefaultExperiencesfields[appClipHeaderImages] (query, optional): the fields to include for returned resources of type appClipHeaderImagesinclude (query, optional): comma-separated list of relationships to include
PATCH /v1/appClipDefaultExperienceLocalizations/{id}
Summary: No summary provided.
DELETE /v1/appClipDefaultExperienceLocalizations/{id}
Summary: No summary provided.
POST /v1/appClipDefaultExperiences
Summary: No summary provided.
GET /v1/appClipDefaultExperiences/{id}
Summary: No summary provided.
Parameters:
fields[appClipDefaultExperiences] (query, optional): the fields to include for returned resources of type appClipDefaultExperiencesfields[appClips] (query, optional): the fields to include for returned resources of type appClipsfields[appStoreVersions] (query, optional): the fields to include for returned resources of type appStoreVersionsfields[appClipDefaultExperienceLocalizations] (query, optional): the fields to include for returned resources of type appClipDefaultExperienceLocalizationsfields[appClipAppStoreReviewDetails] (query, optional): the fields to include for returned resources of type appClipAppStoreReviewDetailsinclude (query, optional): comma-separated list of relationships to includelimit[appClipDefaultExperienceLocalizations] (query, optional): maximum number of related appClipDefaultExperienceLocalizations returned (when they are included)
PATCH /v1/appClipDefaultExperiences/{id}
Summary: No summary provided.
DELETE /v1/appClipDefaultExperiences/{id}
Summary: No summary provided.
POST /v1/appClipHeaderImages
Summary: No summary provided.
GET /v1/appClipHeaderImages/{id}
Summary: No summary provided.
Parameters:
fields[appClipHeaderImages] (query, optional): the fields to include for returned resources of type appClipHeaderImagesfields[appClipDefaultExperienceLocalizations] (query, optional): the fields to include for returned resources of type appClipDefaultExperienceLocalizationsinclude (query, optional): comma-separated list of relationships to include
PATCH /v1/appClipHeaderImages/{id}
Summary: No summary provided.
DELETE /v1/appClipHeaderImages/{id}
Summary: No summary provided.
GET /v1/appClips/{id}
Summary: No summary provided.
Parameters:
fields[appClips] (query, optional): the fields to include for returned resources of type appClipsfields[apps] (query, optional): the fields to include for returned resources of type appsfields[appClipDefaultExperiences] (query, optional): the fields to include for returned resources of type appClipDefaultExperiencesinclude (query, optional): comma-separated list of relationships to includelimit[appClipDefaultExperiences] (query, optional): maximum number of related appClipDefaultExperiences returned (when they are included)
GET /v1/appClipDefaultExperienceLocalizations/{id}/relationships/appClipHeaderImage
Summary: No summary provided.
GET /v1/appClipDefaultExperienceLocalizations/{id}/appClipHeaderImage
Summary: No summary provided.
Parameters:
fields[appClipHeaderImages] (query, optional): the fields to include for returned resources of type appClipHeaderImagesfields[appClipDefaultExperienceLocalizations] (query, optional): the fields to include for returned resources of type appClipDefaultExperienceLocalizationsinclude (query, optional): comma-separated list of relationships to include
GET /v1/appClipDefaultExperiences/{id}/relationships/appClipAppStoreReviewDetail
Summary: No summary provided.
GET /v1/appClipDefaultExperiences/{id}/appClipAppStoreReviewDetail
Summary: No summary provided.
Parameters:
fields[appClipAppStoreReviewDetails] (query, optional): the fields to include for returned resources of type appClipAppStoreReviewDetailsfields[appClipDefaultExperiences] (query, optional): the fields to include for returned resources of type appClipDefaultExperiencesinclude (query, optional): comma-separated list of relationships to include
GET /v1/appClipDefaultExperiences/{id}/relationships/appClipDefaultExperienceLocalizations
Summary: No summary provided.
Parameters:
limit (query, optional): maximum resources per page
GET /v1/appClipDefaultExperiences/{id}/appClipDefaultExperienceLocalizations
Summary: No summary provided.
Parameters:
filter[locale] (query, optional): filter by attribute 'locale'fields[appClipDefaultExperienceLocalizations] (query, optional): the fields to include for returned resources of type appClipDefaultExperienceLocalizationsfields[appClipDefaultExperiences] (query, optional): the fields to include for returned resources of type appClipDefaultExperiencesfields[appClipHeaderImages] (query, optional): the fields to include for returned resources of type appClipHeaderImageslimit (query, optional): maximum resources per pageinclude (query, optional): comma-separated list of relationships to include
GET /v1/appClipDefaultExperiences/{id}/relationships/releaseWithAppStoreVersion
Summary: No summary provided.
PATCH /v1/appClipDefaultExperiences/{id}/relationships/releaseWithAppStoreVersion
Summary: No summary provided.
GET /v1/appClipDefaultExperiences/{id}/releaseWithAppStoreVersion
Summary: No summary provided.
Parameters:
fields[appStoreVersions] (query, optional): the fields to include for returned resources of type appStoreVersionsfields[apps] (query, optional): the fields to include for returned resources of type appsfields[appStoreVersionLocalizations] (query, optional): the fields to include for returned resources of type appStoreVersionLocalizationsfields[builds] (query, optional): the fields to include for returned resources of type buildsfields[appStoreVersionPhasedReleases] (query, optional): the fields to include for returned resources of type appStoreVersionPhasedReleasesfields[gameCenterAppVersions] (query, optional): the fields to include for returned resources of type gameCenterAppVersionsfields[routingAppCoverages] (query, optional): the fields to include for returned resources of type routingAppCoveragesfields[appStoreReviewDetails] (query, optional): the fields to include for returned resources of type appStoreReviewDetailsfields[appStoreVersionSubmissions] (query, optional): the fields to include for returned resources of type appStoreVersionSubmissionsfields[appClipDefaultExperiences] (query, optional): the fields to include for returned resources of type appClipDefaultExperiencesfields[appStoreVersionExperiments] (query, optional): the fields to include for returned resources of type appStoreVersionExperimentsfields[alternativeDistributionPackages] (query, optional): the fields to include for returned resources of type alternativeDistributionPackagesinclude (query, optional): comma-separated list of relationships to includelimit[appStoreVersionLocalizations] (query, optional): maximum number of related appStoreVersionLocalizations returned (when they are included)limit[appStoreVersionExperiments] (query, optional): maximum number of related appStoreVersionExperiments returned (when they are included)limit[appStoreVersionExperimentsV2] (query, optional): maximum number of related appStoreVersionExperimentsV2 returned (when they are included)
GET /v1/appClips/{id}/relationships/appClipAdvancedExperiences
Summary: No summary provided.
Parameters:
limit (query, optional): maximum resources per page
GET /v1/appClips/{id}/appClipAdvancedExperiences
Summary: No summary provided.
Parameters:
filter[status] (query, optional): filter by attribute 'status'filter[placeStatus] (query, optional): filter by attribute 'placeStatus'filter[action] (query, optional): filter by attribute 'action'fields[appClipAdvancedExperiences] (query, optional): the fields to include for returned resources of type appClipAdvancedExperiencesfields[appClips] (query, optional): the fields to include for returned resources of type appClipsfields[appClipAdvancedExperienceImages] (query, optional): the fields to include for returned resources of type appClipAdvancedExperienceImagesfields[appClipAdvancedExperienceLocalizations] (query, optional): the fields to include for returned resources of type appClipAdvancedExperienceLocalizationslimit (query, optional): maximum resources per pageinclude (query, optional): comma-separated list of relationships to includelimit[localizations] (query, optional): maximum number of related localizations returned (when they are included)
GET /v1/appClips/{id}/relationships/appClipDefaultExperiences
Summary: No summary provided.
Parameters:
limit (query, optional): maximum resources per page
GET /v1/appClips/{id}/appClipDefaultExperiences
Summary: No summary provided.
Parameters:
exists[releaseWithAppStoreVersion] (query, optional): filter by existence or non-existence of related 'releaseWithAppStoreVersion'fields[appClipDefaultExperiences] (query, optional): the fields to include for returned resources of type appClipDefaultExperiencesfields[appClips] (query, optional): the fields to include for returned resources of type appClipsfields[appStoreVersions] (query, optional): the fields to include for returned resources of type appStoreVersionsfields[appClipDefaultExperienceLocalizations] (query, optional): the fields to include for returned resources of type appClipDefaultExperienceLocalizationsfields[appClipAppStoreReviewDetails] (query, optional): the fields to include for returned resources of type appClipAppStoreReviewDetailslimit (query, optional): maximum resources per pageinclude (query, optional): comma-separated list of relationships to includelimit[appClipDefaultExperienceLocalizations] (query, optional): maximum number of related appClipDefaultExperienceLocalizations returned (when they are included)
Typical Workflows
Use these endpoints to automate app clips tasks within Apple Store Connect.
Best Practices
- Always authenticate requests using your Apple Store Connect API key (JWT token).
- Handle rate limiting gracefully, as the Apple Store Connect API enforces quotas.
- When writing integrations, refer back to the exact schemas for precise payload construction.
1---2name: app-clips3description: Endpoints for managing App Clips and default experiences.4---56# App Clips7Endpoints for managing App Clips and default experiences.89## Endpoints1011### `POST /v1/appClipAdvancedExperienceImages`12**Summary**: No summary provided.1314### `GET /v1/appClipAdvancedExperienceImages/{id}`15**Summary**: No summary provided.1617**Parameters**:18- `fields[appClipAdvancedExperienceImages]` (query, optional): the fields to include for returned resources of type appClipAdvancedExperienceImages1920### `PATCH /v1/appClipAdvancedExperienceImages/{id}`21**Summary**: No summary provided.2223### `POST /v1/appClipAdvancedExperiences`24**Summary**: No summary provided.2526### `GET /v1/appClipAdvancedExperiences/{id}`27**Summary**: No summary provided.2829**Parameters**:30- `fields[appClipAdvancedExperiences]` (query, optional): the fields to include for returned resources of type appClipAdvancedExperiences31- `fields[appClips]` (query, optional): the fields to include for returned resources of type appClips32- `fields[appClipAdvancedExperienceImages]` (query, optional): the fields to include for returned resources of type appClipAdvancedExperienceImages33- `fields[appClipAdvancedExperienceLocalizations]` (query, optional): the fields to include for returned resources of type appClipAdvancedExperienceLocalizations34- `include` (query, optional): comma-separated list of relationships to include35- `limit[localizations]` (query, optional): maximum number of related localizations returned (when they are included)3637### `PATCH /v1/appClipAdvancedExperiences/{id}`38**Summary**: No summary provided.3940### `POST /v1/appClipAppStoreReviewDetails`41**Summary**: No summary provided.4243### `GET /v1/appClipAppStoreReviewDetails/{id}`44**Summary**: No summary provided.4546**Parameters**:47- `fields[appClipAppStoreReviewDetails]` (query, optional): the fields to include for returned resources of type appClipAppStoreReviewDetails48- `fields[appClipDefaultExperiences]` (query, optional): the fields to include for returned resources of type appClipDefaultExperiences49- `include` (query, optional): comma-separated list of relationships to include5051### `PATCH /v1/appClipAppStoreReviewDetails/{id}`52**Summary**: No summary provided.5354### `POST /v1/appClipDefaultExperienceLocalizations`55**Summary**: No summary provided.5657### `GET /v1/appClipDefaultExperienceLocalizations/{id}`58**Summary**: No summary provided.5960**Parameters**:61- `fields[appClipDefaultExperienceLocalizations]` (query, optional): the fields to include for returned resources of type appClipDefaultExperienceLocalizations62- `fields[appClipDefaultExperiences]` (query, optional): the fields to include for returned resources of type appClipDefaultExperiences63- `fields[appClipHeaderImages]` (query, optional): the fields to include for returned resources of type appClipHeaderImages64- `include` (query, optional): comma-separated list of relationships to include6566### `PATCH /v1/appClipDefaultExperienceLocalizations/{id}`67**Summary**: No summary provided.6869### `DELETE /v1/appClipDefaultExperienceLocalizations/{id}`70**Summary**: No summary provided.7172### `POST /v1/appClipDefaultExperiences`73**Summary**: No summary provided.7475### `GET /v1/appClipDefaultExperiences/{id}`76**Summary**: No summary provided.7778**Parameters**:79- `fields[appClipDefaultExperiences]` (query, optional): the fields to include for returned resources of type appClipDefaultExperiences80- `fields[appClips]` (query, optional): the fields to include for returned resources of type appClips81- `fields[appStoreVersions]` (query, optional): the fields to include for returned resources of type appStoreVersions82- `fields[appClipDefaultExperienceLocalizations]` (query, optional): the fields to include for returned resources of type appClipDefaultExperienceLocalizations83- `fields[appClipAppStoreReviewDetails]` (query, optional): the fields to include for returned resources of type appClipAppStoreReviewDetails84- `include` (query, optional): comma-separated list of relationships to include85- `limit[appClipDefaultExperienceLocalizations]` (query, optional): maximum number of related appClipDefaultExperienceLocalizations returned (when they are included)8687### `PATCH /v1/appClipDefaultExperiences/{id}`88**Summary**: No summary provided.8990### `DELETE /v1/appClipDefaultExperiences/{id}`91**Summary**: No summary provided.9293### `POST /v1/appClipHeaderImages`94**Summary**: No summary provided.9596### `GET /v1/appClipHeaderImages/{id}`97**Summary**: No summary provided.9899**Parameters**:100- `fields[appClipHeaderImages]` (query, optional): the fields to include for returned resources of type appClipHeaderImages101- `fields[appClipDefaultExperienceLocalizations]` (query, optional): the fields to include for returned resources of type appClipDefaultExperienceLocalizations102- `include` (query, optional): comma-separated list of relationships to include103104### `PATCH /v1/appClipHeaderImages/{id}`105**Summary**: No summary provided.106107### `DELETE /v1/appClipHeaderImages/{id}`108**Summary**: No summary provided.109110### `GET /v1/appClips/{id}`111**Summary**: No summary provided.112113**Parameters**:114- `fields[appClips]` (query, optional): the fields to include for returned resources of type appClips115- `fields[apps]` (query, optional): the fields to include for returned resources of type apps116- `fields[appClipDefaultExperiences]` (query, optional): the fields to include for returned resources of type appClipDefaultExperiences117- `include` (query, optional): comma-separated list of relationships to include118- `limit[appClipDefaultExperiences]` (query, optional): maximum number of related appClipDefaultExperiences returned (when they are included)119120### `GET /v1/appClipDefaultExperienceLocalizations/{id}/relationships/appClipHeaderImage`121**Summary**: No summary provided.122123### `GET /v1/appClipDefaultExperienceLocalizations/{id}/appClipHeaderImage`124**Summary**: No summary provided.125126**Parameters**:127- `fields[appClipHeaderImages]` (query, optional): the fields to include for returned resources of type appClipHeaderImages128- `fields[appClipDefaultExperienceLocalizations]` (query, optional): the fields to include for returned resources of type appClipDefaultExperienceLocalizations129- `include` (query, optional): comma-separated list of relationships to include130131### `GET /v1/appClipDefaultExperiences/{id}/relationships/appClipAppStoreReviewDetail`132**Summary**: No summary provided.133134### `GET /v1/appClipDefaultExperiences/{id}/appClipAppStoreReviewDetail`135**Summary**: No summary provided.136137**Parameters**:138- `fields[appClipAppStoreReviewDetails]` (query, optional): the fields to include for returned resources of type appClipAppStoreReviewDetails139- `fields[appClipDefaultExperiences]` (query, optional): the fields to include for returned resources of type appClipDefaultExperiences140- `include` (query, optional): comma-separated list of relationships to include141142### `GET /v1/appClipDefaultExperiences/{id}/relationships/appClipDefaultExperienceLocalizations`143**Summary**: No summary provided.144145**Parameters**:146- `limit` (query, optional): maximum resources per page147148### `GET /v1/appClipDefaultExperiences/{id}/appClipDefaultExperienceLocalizations`149**Summary**: No summary provided.150151**Parameters**:152- `filter[locale]` (query, optional): filter by attribute 'locale'153- `fields[appClipDefaultExperienceLocalizations]` (query, optional): the fields to include for returned resources of type appClipDefaultExperienceLocalizations154- `fields[appClipDefaultExperiences]` (query, optional): the fields to include for returned resources of type appClipDefaultExperiences155- `fields[appClipHeaderImages]` (query, optional): the fields to include for returned resources of type appClipHeaderImages156- `limit` (query, optional): maximum resources per page157- `include` (query, optional): comma-separated list of relationships to include158159### `GET /v1/appClipDefaultExperiences/{id}/relationships/releaseWithAppStoreVersion`160**Summary**: No summary provided.161162### `PATCH /v1/appClipDefaultExperiences/{id}/relationships/releaseWithAppStoreVersion`163**Summary**: No summary provided.164165### `GET /v1/appClipDefaultExperiences/{id}/releaseWithAppStoreVersion`166**Summary**: No summary provided.167168**Parameters**:169- `fields[appStoreVersions]` (query, optional): the fields to include for returned resources of type appStoreVersions170- `fields[apps]` (query, optional): the fields to include for returned resources of type apps171- `fields[appStoreVersionLocalizations]` (query, optional): the fields to include for returned resources of type appStoreVersionLocalizations172- `fields[builds]` (query, optional): the fields to include for returned resources of type builds173- `fields[appStoreVersionPhasedReleases]` (query, optional): the fields to include for returned resources of type appStoreVersionPhasedReleases174- `fields[gameCenterAppVersions]` (query, optional): the fields to include for returned resources of type gameCenterAppVersions175- `fields[routingAppCoverages]` (query, optional): the fields to include for returned resources of type routingAppCoverages176- `fields[appStoreReviewDetails]` (query, optional): the fields to include for returned resources of type appStoreReviewDetails177- `fields[appStoreVersionSubmissions]` (query, optional): the fields to include for returned resources of type appStoreVersionSubmissions178- `fields[appClipDefaultExperiences]` (query, optional): the fields to include for returned resources of type appClipDefaultExperiences179- `fields[appStoreVersionExperiments]` (query, optional): the fields to include for returned resources of type appStoreVersionExperiments180- `fields[alternativeDistributionPackages]` (query, optional): the fields to include for returned resources of type alternativeDistributionPackages181- `include` (query, optional): comma-separated list of relationships to include182- `limit[appStoreVersionLocalizations]` (query, optional): maximum number of related appStoreVersionLocalizations returned (when they are included)183- `limit[appStoreVersionExperiments]` (query, optional): maximum number of related appStoreVersionExperiments returned (when they are included)184- `limit[appStoreVersionExperimentsV2]` (query, optional): maximum number of related appStoreVersionExperimentsV2 returned (when they are included)185186### `GET /v1/appClips/{id}/relationships/appClipAdvancedExperiences`187**Summary**: No summary provided.188189**Parameters**:190- `limit` (query, optional): maximum resources per page191192### `GET /v1/appClips/{id}/appClipAdvancedExperiences`193**Summary**: No summary provided.194195**Parameters**:196- `filter[status]` (query, optional): filter by attribute 'status'197- `filter[placeStatus]` (query, optional): filter by attribute 'placeStatus'198- `filter[action]` (query, optional): filter by attribute 'action'199- `fields[appClipAdvancedExperiences]` (query, optional): the fields to include for returned resources of type appClipAdvancedExperiences200- `fields[appClips]` (query, optional): the fields to include for returned resources of type appClips201- `fields[appClipAdvancedExperienceImages]` (query, optional): the fields to include for returned resources of type appClipAdvancedExperienceImages202- `fields[appClipAdvancedExperienceLocalizations]` (query, optional): the fields to include for returned resources of type appClipAdvancedExperienceLocalizations203- `limit` (query, optional): maximum resources per page204- `include` (query, optional): comma-separated list of relationships to include205- `limit[localizations]` (query, optional): maximum number of related localizations returned (when they are included)206207### `GET /v1/appClips/{id}/relationships/appClipDefaultExperiences`208**Summary**: No summary provided.209210**Parameters**:211- `limit` (query, optional): maximum resources per page212213### `GET /v1/appClips/{id}/appClipDefaultExperiences`214**Summary**: No summary provided.215216**Parameters**:217- `exists[releaseWithAppStoreVersion]` (query, optional): filter by existence or non-existence of related 'releaseWithAppStoreVersion'218- `fields[appClipDefaultExperiences]` (query, optional): the fields to include for returned resources of type appClipDefaultExperiences219- `fields[appClips]` (query, optional): the fields to include for returned resources of type appClips220- `fields[appStoreVersions]` (query, optional): the fields to include for returned resources of type appStoreVersions221- `fields[appClipDefaultExperienceLocalizations]` (query, optional): the fields to include for returned resources of type appClipDefaultExperienceLocalizations222- `fields[appClipAppStoreReviewDetails]` (query, optional): the fields to include for returned resources of type appClipAppStoreReviewDetails223- `limit` (query, optional): maximum resources per page224- `include` (query, optional): comma-separated list of relationships to include225- `limit[appClipDefaultExperienceLocalizations]` (query, optional): maximum number of related appClipDefaultExperienceLocalizations returned (when they are included)226227## Typical Workflows228Use these endpoints to automate app clips tasks within Apple Store Connect.229230## Best Practices231- Always authenticate requests using your Apple Store Connect API key (JWT token).232- Handle rate limiting gracefully, as the Apple Store Connect API enforces quotas.233- When writing integrations, refer back to the exact schemas for precise payload construction.
Andersonlimahw