Remove a request from a portal

DELETE

/v1/portals/{portalId}/requests/{requestId}

curl --request DELETE \
  --url https://api.pealboard.com/v1/portals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/requests/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• production

Deletes the request row and leaves the issue untouched in GitHub, along with every comment on it. The customer stops seeing it. The marker in the issue body still names the portal, so a later restore can reconnect the two.

Access. Requires the member role or above (member, admin, owner). Taking a request off a portal is undoing a share, which is the same kind of act. API-key scope: requests:write.

Authorizations

• bearerAuth

Parameters

Path Parameters

portalId

required

From GET /v1/portals.

string format: uuid

From GET /v1/portals.

requestId

required

A UUID this API issued.

string format: uuid

A UUID this API issued.

Responses

200

The request is removed.

Media typeapplication/json

object

ok

required

boolean

Example

{
  "ok": true
}

401

No valid credentials.

Media typeapplication/json

object

error

required

object

code

required

A stable identifier for the kind of failure. Safe to branch on.

string

message

required

What went wrong, written for a person.

string

detail

Structured particulars, when there are any.

object

key

additional properties

remedy

What to do about it, when there is something to do.

string

requestId

required

Quote this when asking about a specific failure.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}

403

Authenticated, but not permitted.

Media typeapplication/json

object

error

required

object

code

required

A stable identifier for the kind of failure. Safe to branch on.

string

message

required

What went wrong, written for a person.

string

detail

Structured particulars, when there are any.

object

key

additional properties

remedy

What to do about it, when there is something to do.

string

requestId

required

Quote this when asking about a specific failure.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}

404

No such resource, or it is not visible to you.

Media typeapplication/json

object

error

required

object

code

required

A stable identifier for the kind of failure. Safe to branch on.

string

message

required

What went wrong, written for a person.

string

detail

Structured particulars, when there are any.

object

key

additional properties

remedy

What to do about it, when there is something to do.

string

requestId

required

Quote this when asking about a specific failure.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}

409

The request conflicts with the current state.

Media typeapplication/json

object

error

required

object

code

required

A stable identifier for the kind of failure. Safe to branch on.

string

message

required

What went wrong, written for a person.

string

detail

Structured particulars, when there are any.

object

key

additional properties

remedy

What to do about it, when there is something to do.

string

requestId

required

Quote this when asking about a specific failure.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}

422

The request did not match the expected shape.

Media typeapplication/json

object

error

required

object

code

required

A stable identifier for the kind of failure. Safe to branch on.

string

message

required

What went wrong, written for a person.

string

detail

Structured particulars, when there are any.

object

key

additional properties

remedy

What to do about it, when there is something to do.

string

requestId

required

Quote this when asking about a specific failure.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}

429

Rate limited. Retry after the interval in the header.

Media typeapplication/json

object

error

required

object

code

required

A stable identifier for the kind of failure. Safe to branch on.

string

message

required

What went wrong, written for a person.

string

detail

Structured particulars, when there are any.

object

key

additional properties

remedy

What to do about it, when there is something to do.

string

requestId

required

Quote this when asking about a specific failure.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}

502

GitHub or another dependency refused or did not answer. Nothing in the workspace changed.

Media typeapplication/json

object

error

required

object

code

required

A stable identifier for the kind of failure. Safe to branch on.

string

message

required

What went wrong, written for a person.

string

detail

Structured particulars, when there are any.

object

key

additional properties

remedy

What to do about it, when there is something to do.

string

requestId

required

Quote this when asking about a specific failure.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}