Skip to content

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.

Get more examples for this API

Run our Postman Collection for a full library of example requests and responses for this API.

Run in Postman

Authorization

This API uses Basic Auth, using the API key and secret key for your project. Pass your API key in the request header like {{api-key}}:{{secret-key}}. api-key replaces username, and secret-key replaces the password.

See Find your Amplitude Project API Credentials for help locating your credentials.

Endpoints

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

Create a release

https://amplitude.com/api/2/release

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

POST /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
Host: amplitude.com
Authorization: Basic {{api-key}}:{{secret-key}}
POST /api/2/release HTTP/1.1
Host: amplitude.com
Authorization: Basic {{api-key}}:{{secret-key}}
Content-Type: application/json
Content-Length: 260


{
  "chart_visibility": "true",
  "created_by": "User",
  "description": "Releasing the new paid feature. ",
  "platforms": "iOS",
  "release_end": "2022-01-01 00:00:00",
  "release_start": "2022-01-01 00:00:00",
  "title": "Big new feature",
  "version": "3.5"
}

Release parameters

Name
Description
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.

Response

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

{
    "success": true,
    "release": {
        "id": "xbcehyc",
        "app_id": 50000,
        "org_id": 10001,
        "version": "3.5",
        "release_start": "2022-01-01 00:00:00",
        "release_end": "2022-01-01 00:00:00",
        "type": "integration",
        "title": "Big new feature for iOS",
        "description": "Releasing the new paid feature. ",
        "platforms": [
            "iOS"
        ],
        "chart_visibility": true,
        "params": {
            "created": 1646324226364,
            "created_by": "A User",
            "last_modified": 1646324226364,
            "last_modified_by": "A User"
        }
    }
}

Status codes

Code Message
200 Success
400 Bad Request. Check the message for details.