Releases API

Use the Releases API to programmatically create releases. Integrate this API into your deployment workflows so you can document the product changes your team introduces.


API uses basic authentication, using the API key and secret key for your project. Pass base64-encoded credentials in the request header like {api-key}:{secret-key}. api-key replaces username, and secret-key replaces the password.

Your authorization header should look something like this:

--header 'Authorization: Basic YWhhbWwsdG9uQGFwaWdlZS5jb206bClwYXNzdzByZAo'`

For more information, see Find your API Credentials


Region Endpoint
Standard server
EU residency server

Create a release


You can send the release's parameters as a JSON payload, or query parameters.

1POST /api/2/release?version=2.2&release_start=2022-01-01 00:00:00&release_end=2022-01-01 00:00:00&title=New Feature&description=Releasing the new paid feature. &platforms=iOS&created_by=&chart_visibility=true HTTP/1.1
3Authorization: Basic {api-key}:{secret-key}

1POST /api/2/release HTTP/1.1
3Authorization: Basic {api-key}:{secret-key}
4Content-Type: application/json
5Content-Length: 260
9 "chart_visibility": "true",
10 "created_by": "User",
11 "description": "Releasing the new paid feature. ",
12 "platforms": "iOS",
13 "release_end": "2022-01-01 00:00:00",
14 "release_start": "2022-01-01 00:00:00",
15 "title": "Big new feature",
16 "version": "3.5"

Release parameters

version Required. The version of your product corresponding to this release.
release_start Required. Timestamp corresponding to the start of this release in UTC. Must be in this format: yyyy-MM-dd HH:mm:ss.
release_end Optional. Timestamp corresponding to the end of this release in UTC. Must be in this format: yyyy-MM-dd HH:mm:ss.
title Required. A name for the release.
description Optional. A description for the release.
platforms Optional. A list of platforms for this release.
created_by Optional. Name of the user creating the release, as a string.
chart_visibility Optional. Defaults to true. When true, indicates that this release should show up on charts as an annotation.


A successful request returns a JSON response with the release's information.

2 "success": true,
3 "release": {
4 "id": "xbcehyc",
5 "app_id": 50000,
6 "org_id": 10001,
7 "version": "3.5",
8 "release_start": "2022-01-01 00:00:00",
9 "release_end": "2022-01-01 00:00:00",
10 "type": "integration",
11 "title": "Big new feature for iOS",
12 "description": "Releasing the new paid feature. ",
13 "platforms": [
14 "iOS"
15 ],
16 "chart_visibility": true,
17 "params": {
18 "created": 1646324226364,
19 "created_by": "A User",
20 "last_modified": 1646324226364,
21 "last_modified_by": "A User"
22 }
23 }

Status codes

Code Message
200 Success
400 Bad Request. Check the message for details.
Was this page helpful?

Thanks for your feedback!

May 21st, 2024

Need help? Contact Support


Have a look at the Amplitude Blog

Learn more at Amplitude Academy

© 2024 Amplitude, Inc. All rights reserved. Amplitude is a registered trademark of Amplitude, Inc.