PUT /user/interaction-limits

Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
expiry String No

The duration of the interaction restriction. Default: one_day.

Possible values:

  • "three_days"
  • "one_day"
  • "one_month"
  • "six_months"
  • "one_week"
limit String Yes

The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.

Possible values:

  • "existing_users"
  • "collaborators_only"
  • "contributors_only"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.