A Provider manager can pause or resume an owned offer

Generated from the checked-in source. Do not edit this reference by hand.

PATCH /api/v1/providers/{provider}/offers/{offer}

Pausing prevents new admissions. Already dispatched requests may complete and accrue earnings. Viewers and unrelated operators cannot mutate offers.

Operation: setProviderOfferAvailability.

Authentication

Use the credential and permission scope described above. Each object below is an alternative; schemes within one object are required together.

JSON

[
  {
    "operatorBearer": []
  }
]

HTTP request

Set NIU_ORIGIN to your installation origin (without /v1). Replace path, query and header placeholders with the required values. Query examples use curl 7.87 or newer to encode values with --url-query. Use the credential scope described above; a bearer token must have the authority required by this operation.

Shell

curl --fail-with-body -X PATCH "$NIU_ORIGIN/api/v1/providers/{provider}/offers/{offer}" \
  -H "Authorization: Bearer $NIU_MEMBER_TOKEN" \
  -H 'Content-Type: application/json' \
  --data @request.json

Parameters

provider

Location: path. Required.

JSON

{
  "type": "string",
  "format": "uuid"
}

offer

Location: path. Required.

JSON

{
  "type": "string",
  "format": "uuid"
}

Request body

application/json

Required.

JSON

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "active"
  ],
  "properties": {
    "active": {
      "type": "boolean"
    }
  }
}

Responses

HTTP 200

Availability saved and audited

HTTP 404

No eligible Provider membership

HTTP 409

Offer unavailable in Provider scope

Behavior and supported scope

Pausing prevents new admissions. Already dispatched requests may complete and accrue earnings. Viewers and unrelated operators cannot mutate offers.