# Update metric

PATCH /metrics/{metric}. Parameters, permissions, request and response schemas.

`PATCH /metrics/{metric}`

Update metric. Requires the REST `write` token ability. The bearer token selects the Team; a supplied team\_id cannot switch tenants. Additional role, entity-policy and plan requirements vary by operation. A Team in blocked billing mode cannot write and receives 402.

## Authentication

Use a team API key as `Authorization: Bearer YOUR_API_KEY`. The token ability and the user’s role must both allow this operation. See [authentication](https://conversionlab.app/docs/developer/authentication).

```json
{
  "ability": "write",
  "team": "Token-bound Team",
  "authorization": "Additional role, entity-policy and plan requirements vary by operation.",
  "billing": "Blocked billing mode rejects writes with 402."
}
```

## Parameters

| Name     | Location | Required | Description   |
| -------- | -------- | -------- | ------------- |
| `metric` | path     | Yes      | The metric ID |

### metric

```json
{
  "type": "integer",
  "minimum": 1
}
```

## Request body

The request body is optional.

### application/json

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 255
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "winning_direction": {
      "type": "string",
      "enum": [
        "increasing",
        "decreasing"
      ],
      "title": "MetricWinningDirection"
    },
    "type": {
      "type": "string",
      "enum": [
        "average-per-user",
        "rate-per-user",
        "average-per-session",
        "rate-per-session"
      ],
      "title": "MetricType"
    }
  },
  "title": "UpdateMetricRequest"
}
```

```json
{
  "name": "Checkout delivery estimate",
  "description": null
}
```

## Example request

```bash
curl --request PATCH 'https://api.example.test/api/metrics/1' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Checkout delivery estimate","description":null}'
```

Examples use fictional data. Replace resource IDs and the API host with your environment’s values.

## Responses

### 200

`MetricResource`

Content type: `application/json`.

```json
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "import_source": {
          "type": [
            "string",
            "null"
          ]
        },
        "import_source_ref": {
          "type": [
            "string",
            "null"
          ]
        },
        "import_source_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "data_import_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "imported_at": {
          "type": [
            "string",
            "null"
          ]
        },
        "project_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "type": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "average-per-user",
                "rate-per-user",
                "average-per-session",
                "rate-per-session"
              ],
              "title": "MetricType"
            },
            {
              "type": "null"
            }
          ]
        },
        "winning_direction": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "increasing",
                "decreasing"
              ],
              "title": "MetricWinningDirection"
            },
            {
              "type": "null"
            }
          ]
        },
        "external_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "external_platform": {
          "type": [
            "string",
            "null"
          ]
        },
        "external_synced_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "external_metadata": {
          "description": "JSON object or array. Object keys depend on the provider, form question, or configuration being stored.",
          "anyOf": [
            {
              "type": "object",
              "additionalProperties": {
                "description": "An arbitrary JSON value retained by a metadata/settings field.",
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "boolean"
                  },
                  {
                    "type": "number"
                  },
                  {
                    "type": "string"
                  },
                  {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/JsonValue"
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": {
                      "$ref": "#/components/schemas/JsonValue"
                    }
                  }
                ]
              }
            },
            {
              "type": "array",
              "items": {
                "description": "An arbitrary JSON value retained by a metadata/settings field.",
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "boolean"
                  },
                  {
                    "type": "number"
                  },
                  {
                    "type": "string"
                  },
                  {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/JsonValue"
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": {
                      "$ref": "#/components/schemas/JsonValue"
                    }
                  }
                ]
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "created_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updated_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "deleted_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "required": [
        "id",
        "import_source",
        "import_source_ref",
        "import_source_id",
        "data_import_id",
        "imported_at",
        "project_id",
        "name",
        "description",
        "type",
        "winning_direction",
        "external_id",
        "external_platform",
        "external_synced_at",
        "external_metadata",
        "created_at",
        "updated_at",
        "deleted_at"
      ],
      "title": "MetricResource"
    }
  },
  "required": [
    "data"
  ]
}
```

```json
{
  "data": {
    "id": 101,
    "import_source": null,
    "import_source_ref": null,
    "import_source_id": null,
    "data_import_id": null,
    "imported_at": null,
    "project_id": null,
    "name": "Checkout delivery estimate",
    "description": null,
    "type": null,
    "winning_direction": null,
    "external_id": null,
    "external_platform": null,
    "external_synced_at": null,
    "external_metadata": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null
  }
}
```

### 401

Unauthenticated

Content type: `application/json`.

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error overview."
    }
  },
  "required": [
    "message"
  ]
}
```

```json
{
  "message": "The request could not be completed."
}
```

### 402

The Team is in read-only billing mode.

Content type: `application/json`.

```json
{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "const": "subscription_required"
    },
    "mode": {
      "type": "string",
      "const": "blocked"
    },
    "message": {
      "type": "string",
      "example": "Your team is in read-only mode. Update billing to make changes."
    },
    "grace_period_ends_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  },
  "required": [
    "error",
    "mode",
    "message",
    "grace_period_ends_at"
  ]
}
```

```json
{
  "error": "subscription_required",
  "mode": "blocked",
  "message": "Your team is in read-only mode. Update billing to make changes.",
  "grace_period_ends_at": null
}
```

### 403

Authorization error

Content type: `application/json`.

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error overview."
    }
  },
  "required": [
    "message"
  ]
}
```

```json
{
  "message": "The request could not be completed."
}
```

### 404

Not found

Content type: `application/json`.

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error overview."
    }
  },
  "required": [
    "message"
  ]
}
```

```json
{
  "message": "The request could not be completed."
}
```

### 422

Validation error

Content type: `application/json`.

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Errors overview."
    },
    "errors": {
      "type": "object",
      "description": "A detailed description of each field that failed validation.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "message",
    "errors"
  ]
}
```

```json
{
  "message": "The request could not be completed.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}
```

### 429

Rate limit exceeded. Honor Retry-After before retrying.

Response headers:

```json
{
  "Retry-After": {
    "description": "Seconds before retrying.",
    "schema": {
      "type": "integer"
    }
  }
}
```

Content type: `application/json`.

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "example": "Too Many Attempts."
    }
  },
  "required": [
    "message"
  ]
}
```

```json
{
  "message": "Too Many Attempts."
}
```

See [API conventions](https://conversionlab.app/docs/developer/api-conventions) for error handling, rate limits, pagination, and uploads.