Flavours API
Deployment

Update Deployment

POST
/api/v2/deployments/{deploymentId}

Update a specific deployment by its ID.

AuthorizationBearer <token>

You can retrieve your token by logging in.

In: header

Path Parameters

deploymentId*uuid

Header Parameters

X-API-Version*string

API contract version to target. See the Changelog for what changed in each version.

Default"2.0.0"
Value in"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"

Request Body

application/json

platform?|

Deployment platform.

Value in"ANDROID" | "IOS" | "WINDOWS" | "MACOS" | "LINUX"
version?|

Version number. Must not be greater than 191 characters.

file_url?|

URL to download the deployment file. Must be a valid URL.

release_notes?|

Release notes for this deployment.

new_features*array<>
improvements*array<>
bug_fixes*array<>
min_os_version?|

Minimum OS version required. Must not be greater than 50 characters.

max_os_version?|

Maximum OS version supported. Must not be greater than 50 characters.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:8000/api/v2/deployments/et" \  -H "X-API-Version: 2.3.0" \  -H "Content-Type: application/json" \  -d '{    "new_features": [      "voluptas"    ],    "improvements": [      "aliquid"    ],    "bug_fixes": [      "quo"    ]  }'
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Deployment updated successfully."
  },
  "data": {
    "id": "74b20562-c16a-43b4-a8bb-92ca445c20b1",
    "platform": "MACOS",
    "version": "7.34.93",
    "file_url": "https://www.smith.info/fuga-dolorum-in-nulla-provident-nam-beatae",
    "release_notes": "Sed nesciunt iste asperiores dicta sit ab. Aliquid non consequatur fugit. Voluptatem quis dolores ipsam rerum itaque in. Nesciunt ad eaque sunt quaerat.",
    "new_features": [
      "Nobis quia qui similique modi.",
      "Officia et quibusdam consequatur temporibus reprehenderit temporibus.",
      "Dignissimos sit molestias adipisci atque voluptatem."
    ],
    "improvements": [
      "Veritatis tenetur necessitatibus ut dolores consequuntur facilis sunt.",
      "Numquam aperiam et sed odio."
    ],
    "bug_fixes": [
      "Eos deleniti aliquam dolor dolorum recusandae.",
      "Laborum quod et officiis inventore maxime eveniet voluptate omnis."
    ],
    "min_os_version": "14.0",
    "max_os_version": "16.0",
    "created_at": 1782824835629,
    "updated_at": 1782824835869
  }
}
{
  "meta": {
    "code": 401,
    "status": "error",
    "message": "Unauthenticated."
  },
  "data": null
}
{
  "meta": {
    "code": 403,
    "status": "error",
    "message": "Unauthorized."
  },
  "data": null
}
{
  "meta": {
    "code": 404,
    "status": "error",
    "message": "Resource not found."
  },
  "data": null
}
{
  "meta": {
    "code": 422,
    "status": "error",
    "message": "The selected platform is invalid. (and 2 more errors)"
  },
  "data": [
    {
      "code": 0,
      "message": "The selected platform is invalid.",
      "field": "platform"
    },
    {
      "code": 0,
      "message": "The version must not be greater than 191 characters.",
      "field": "version"
    },
    {
      "code": 0,
      "message": "The file url must be a valid URL.",
      "field": "file_url"
    }
  ]
}
{
  "meta": {
    "code": 500,
    "status": "error",
    "message": "Internal server error."
  },
  "data": null
}