Endpoint

Region	Endpoint
Standard Server	https://amplitude.com/api/2/release
EU Residency Server	https://analytics.eu.amplitude.com/api/2/release

Creating Releases

The Releases API allows you to programmatically create Releases. The API can be easily integrated into your deployment workflows so you can more easily document product changes your team introduces.

Send a POST request to https://amplitude.com/api/2/release

Authenticate via basic authentication with the project's credentials API_Key:Secret_Key. You should literally replace the "API_Key" text with your API Key, and the "Secret_Key" text with your Secret Key.

The post body can be the Release params in a JSON payload with JSON encoding, or with the Release params directly as post data.

Key	Description	Type	Required	Example
version	The version of your product corresponding to this release	string, number	Yes	"2.13.0"
release_start	Timestamp corresponding to the start of this release in UTC. Must be in this format: "YYYY-mm-dd HH:mm:ss"	string	Yes	"2018-09-12 17:00:00"
release_end	Timestamp corresponding to the end of this release in UTC. Must be in this format: "YYYY-mm-dd HH:mm:ss"	string	No	"2018-09-20 17:00:00"
title	A title or name for this release	string	Yes	"Beta Release 2.0"
description	A description for this release	string	No	"Includes new feature and several bug fixes"
platforms	List of platforms for this release	[string]	No	["iOS", "Android", "Web"]
created_by	Name of user creating this release	string	No	"Jane Doe"
chart_visibility	Whether this release should show up on charts as an annotation	boolean	No (defaults to true)	true

Example Request

curl -d "version=120&release_start=2018-09-12 17:00:00-07&release_end=2018-09-13 17:00:00-07&title=Release API TEST 3&description=Add a description like release notes and other useful information&platforms=Android&platforms=iOS&params={\"created_by\": \"[email protected]\"}" -u API_Key:Secret_Key -X POST https://amplitude.com/api/2/release

Example Response

{

"release": 

{

     "description": "",
     "chart_visibility":"true",
     "app_id": 3,
     "platforms": ["Android", "iOS"],
     "release_end": "2018-09-12 17:00:00-07", 
     "id": "o15ux9n", 
     "title": "Release API TEST 3",
     "org_id": 21,
     "release_start": "2018-09-12 17:00:00-07", 
     "version": "120", 
     "params": {
          "last_modified": 1536959160699, 
          "last_modified_by": "[email protected]", 
          "created_by": "[email protected]", 
          "created": 1536959160699
     }, 
     "type": "integration"

}, 
     "success": true

}