POpolar
benefits
public

Update Benefit

Update a benefit.

Scopes: benefits:write

patch/v1/benefits/{id}

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/benefits/{id}
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: benefits:write)
    • or HTTP bearer
    • or HTTP bearer

Path parameters

idstring uuid4 required

The benefit ID.

Request body

OR
OR
OR
OR
OR
OR
OR

Example request

{
  "properties": {
    "repository_owner": "polarsource",
    "repository_name": "private_repo"
  }
}

Response

Benefit updated.

OR
OR
OR
OR
OR
OR
OR

Example response

{
  "properties": {
    "repository_owner": "polarsource",
    "repository_name": "private_repo"
  }
}

Changes

No recorded changes to this operation across all 11 revisions of this API.