Skip to content
Developers
Back to Steward

Update submitter details for several applications

POST
/api/v1/applications/bulk/update-submitter

Normalizes and applies one submitter patch per application. Shared submitters are copied before editing; an explicit resend is always performed.

Authorizations

Section titled “ Authorizations ”

Request Bodyrequired

Section titled “ Request Bodyrequired ”
Media type application/json
object
applicationIds
required

Applications the action applies to

Array<string>
<= 500 items
patch
required

Submitter details applied to every selected application

object
firstName
required
string
lastName
required
string
email
required
string
phoneNumber

Three-way, because “leave it alone” and “clear it” are different instructions and a two-way field cannot say both: OMITTED keeps whatever is stored (and carries it onto a fork), null clears it, an object sets it.

object
countryCode
required
string
phoneNumber
required
string
role

The contact’s role, free text (e.g. Authorised signatory). Three-way like phoneNumber: OMITTED keeps whatever is stored, null or blank clears it, a string sets it. Prefilled on the periodic review’s declaration.

string
nullable <= 200 characters
capacity

The contact’s capacity, free text (e.g. Director). Three-way like role.

string
nullable <= 200 characters
resend

Re-send the onboarding link to the updated email after saving. Works regardless of application status.

boolean
Examples
{
  "applicationIds": [
    "68f2c1a9d4b1f2a3c4d5e6f7",
    "68f2c1a9d4b1f2a3c4d5e6f8",
    "68f2c1a9d4b1f2a3c4d5e6f9"
  ],
  "patch": {
    "firstName": "",
    "lastName": "",
    "email": "",
    "phoneNumber": {
      "countryCode": "+1",
      "phoneNumber": "4143319681"
    },
    "resend": false
  }
}

Responses

Section titled “ Responses ”

200

Section titled “ 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
}