Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  4. On-call scheduling and alerting
    1. Get started
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced guide
  5. Incidents
    1. Get started
    2. Advanced guide
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Integrations
    1. Integrating with Better Stack
  8. Team and account management
    1. Team management
    2. Account settings
    3. Audit logs
    4. Migrating to pay as you go
  9. Uptime API
    1. Get an API token
    2. Monitors
    3. Heartbeats
    4. On-call & incidents
    5. Status pages
    6. Metadata
      1. Metadata API
        1. List all existing metadata GET
        2. Get a single metadata record GET
        3. Create a new metadata record POST
        4. Update an existing metadata record PATCH
        5. Delete an existing metadata record DELETE
        6. Metadata API response params
    7. Integrations

Update an existing metadata record

This will update an existing metadata.

PATCH https://uptime.betterstack.com/api/v3/metadata/{metadata_id}

URL parameters

metadata_id
required string

The ID of metadata you want to update

Headers

Authorization
required string

Bearer $TOKEN

Content_Type
string

application/json

Body parameters

owner_id
string

The ID of the owner

owner_type
string

The type of the owner record - accepted values are Monitor, Heartbeat, Incident, WebhookIntegration, and EmailIntegration

key
string

Metadata key

values
array

Array of metadata values. See the list of metadata API parameters for details.

200

The metadata was successfully updated

Response body

{
  "data": {
    "id": "123456789",
    "type": "metadata",
    "attributes": {
      "key": "Key 3",
      "values": [
        {
          "type": "User",
          "item_id": 123,
          "email": "user@example.com",
          "name": "Example User"
        }
      ],
      "team_name": "Testing",
      "owner_id": "2",
      "owner_type": "Monitor"
    }
  }
}
404

Metadata was not found

Example cURL

Example
curl --request PATCH \
  --url https://uptime.betterstack.com/api/v3/metadata/123456789 \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{"key": "Key 3", "values": [{"type": "User", "email": "user@example.com" }]}'

Previous article

Create a new metadata record

Next article

Delete an existing metadata record