GEgetlago
plans

Replace plan metadata

Changed on

This endpoint replaces all existing metadata on a plan with the provided key-value pairs. Any existing metadata keys not included in the request will be removed.

post/plans/{code}/metadata

Request

Path parameters

codestring required
Example:startup

The code of the plan.

Request body

metadataMetadataObject nullable required

Custom metadata stored as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.

Example request

{
  "metadata": {
    "external_id": "ext-123",
    "synced_at": "2024-01-15",
    "source": null
  }
}

Response

Plan metadata replaced

metadataMetadataObject nullable required

Custom metadata stored as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.

Example response

{
  "metadata": {
    "external_id": "ext-123",
    "synced_at": "2024-01-15",
    "source": null
  }
}

Changes