Hide several applications

POST

/api/v1/applications/bulk/hide

Applications already hidden are reported as skipped. Customer API keys record CLIENT provenance and cannot hide Steward-hidden applications. An optional reason is trimmed (blank means absent) and stored as the hide reason and audit note.

Authorizations

• apiKey

Request Body^required

Media type application/json

object

applicationIds

required

Applications the action applies to

Array<string>

<= 500 items

reason

Why the applications are being hidden. Recorded as the hide reason and in the audit log.

string

<= 1000 characters

Examples

{
  "applicationIds": [
    "68f2c1a9d4b1f2a3c4d5e6f7",
    "68f2c1a9d4b1f2a3c4d5e6f8",
    "68f2c1a9d4b1f2a3c4d5e6f9"
  ],
  "reason": ""
}

{
  "applicationIds": [
    "68f2c1a9d4b1f2a3c4d5e6f7",
    "68f2c1a9d4b1f2a3c4d5e6f8",
    "68f2c1a9d4b1f2a3c4d5e6f9"
  ],
  "reason": "Duplicate applications created by a spreadsheet import"
}

Responses

200

Media type application/json

object

applicationIds

required

Applications this call changed

Array<string>

skippedApplicationIds

required

Applications already in the requested state, left untouched

Array<string>

changedCount

required

How many applications changed

number

skippedCount

required

How many applications were already in the requested state

number

emailFailedApplicationIds

Ids from applicationIds whose onboarding email resend failed; omitted when none

Array<string>

Examples

{
  "applicationIds": [
    "68f2c1a9d4b1f2a3c4d5e6f7",
    "68f2c1a9d4b1f2a3c4d5e6f8"
  ],
  "skippedApplicationIds": [
    "68f2c1a9d4b1f2a3c4d5e6f9"
  ],
  "changedCount": 2,
  "skippedCount": 1
}

{
  "applicationIds": [
    "68f2c1a9d4b1f2a3c4d5e6f7",
    "68f2c1a9d4b1f2a3c4d5e6f8"
  ],
  "skippedApplicationIds": [
    "68f2c1a9d4b1f2a3c4d5e6f9"
  ],
  "changedCount": 2,
  "skippedCount": 1,
  "emailFailedApplicationIds": [
    "68f2c1a9d4b1f2a3c4d5e6f8"
  ]
}