Add or remove a label across several investors

POST

/api/v1/applications/bulk/label

Applies or clears one label per selected application. Applications already in the requested state are reported as skipped.

Authorizations

• apiKey

Request Body^required

Media type application/json

object

applicationIds

required

Applications the action applies to

Array<string>

<= 500 items

labelId

required

The label to apply or clear across the selection

string

action

required

Whether the label is added to or removed from every selected application

string

Allowed values: add remove

Example

{
  "applicationIds": [
    "68f2c1a9d4b1f2a3c4d5e6f7",
    "68f2c1a9d4b1f2a3c4d5e6f8",
    "68f2c1a9d4b1f2a3c4d5e6f9"
  ],
  "labelId": "68f2c1a9d4b1f2a3c4d5e6f7",
  "action": "add"
}

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"
  ]
}