GEgetlago
plans

Merge plan metadata

Changed on

This endpoint merges the provided metadata with existing metadata on the plan. Existing keys not in the request are preserved. New keys are added, existing keys are updated.

patch/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 merged

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