Update Subclient - Multigate

Request

Path Params

clientId

string

required

Client's ID

id

string

required

SubClient's ID

Body Params application/json

UpdateSubClientInput type

businessName

string

optional

Name of the business (optional, must be a non-empty string)

registrationNumber

string

optional

Registration number of the business (optional, must be a non-empty string)

businessAddressLine1

string

optional

The first line of the business address (optional, must be a non-empty string)

businessAddressLine2

string

optional

The second line of the business address (optional, must be a non-empty string)

businessContactEmail

string

optional

Contact email for the business (optional, must be a non-empty string)

businessContactPhone

string

optional

Contact phone number for the business (optional, must be a non-empty string)

registrationDate

string

optional

Registration date of the business (optional, must be a non-empty string)

countryOfRegistration

string

optional

Country of registration for the business (optional, must be a non-empty string)

operatingCountries

array[string]

optional

List of countries where the business operates (optional, must not be empty)

operatingIndustries

array[string]

optional

List of industries in which the business operates (optional, must not be empty)

city

string

optional

City where the business is located (optional, must be a non-empty string)

state

string

optional

State where the business is located (optional, must be a non-empty string)

postalCode

string

optional

Postal code of the business address (optional, must be a non-empty string)

Example

{
  "businessName": "string",
  "registrationNumber": "string",
  "businessAddressLine1": "string",
  "businessAddressLine2": "string",
  "businessContactEmail": "string",
  "businessContactPhone": "string",
  "registrationDate": "string",
  "countryOfRegistration": "string",
  "operatingCountries": [
    "string"
  ],
  "operatingIndustries": [
    "string"
  ],
  "city": "string",
  "state": "string",
  "postalCode": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PATCH 'https://api-gateway-uat.mmacs.io/platform/client-service/api/v1/clients//sub-clients/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "businessName": "string",
    "registrationNumber": "string",
    "businessAddressLine1": "string",
    "businessAddressLine2": "string",
    "businessContactEmail": "string",
    "businessContactPhone": "string",
    "registrationDate": "string",
    "countryOfRegistration": "string",
    "operatingCountries": [
        "string"
    ],
    "operatingIndustries": [
        "string"
    ],
    "city": "string",
    "state": "string",
    "postalCode": "string"
}'

Responses

🟢200OK

application/json

success response

Body

SubClientOutput type

data

object (SubClientOutputData)

optional

the response data object

entityId

string

optional

The unique identifier for the subclient.

name

string

optional

The name of the subclient.

subClientType

string

optional

The type of subclient e.g. 'subsidiary', 'client'

businessContactPhone

string

optional

The contact phone number for the business.

businessContactEmail

string

optional

The contact email for the business.

countryOfRegistration

string

optional

The country where the business is registered.

stagesRemaining

array[string]

optional

Array listing the stages remaining in the process.

approvalStatus

string

optional

Maker/checker approval status (this can be ignored for API users)

businessName

string

optional

The registered name of the business.

registrationDate

string

optional

The date the business was registered.

businessAddressLine1

string

optional

The first line of the business's address.

operatingCountries

array[string]

optional

Countries where the business operates.

operatingIndustries

array[string]

optional

Industries in which the business operates.

status

enum<string>

optional

The current status of the subclient

Allowed values:

draftprocessingactiveinactiveblocked

createdAt

string

optional

The date the subclient record was created.

updatedAt

string

optional

The date the subclient record was last updated

parentClientId

string

optional

The unique identifier of the parent client

approvalComments

string

optional

Maker/checker approval comments (this can be ignored for API users)

approvalDate

string

optional

Maker/checker approval date (this can be ignored for API users)

Example

{
  "data": {
    "entityId": "string",
    "name": "string",
    "subClientType": "string",
    "businessContactPhone": "string",
    "businessContactEmail": "string",
    "countryOfRegistration": "string",
    "stagesRemaining": [
      "string"
    ],
    "approvalStatus": "string",
    "businessName": "string",
    "registrationDate": "string",
    "businessAddressLine1": "string",
    "operatingCountries": [
      "string"
    ],
    "operatingIndustries": [
      "string"
    ],
    "status": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "parentClientId": "string",
    "approvalComments": "string",
    "approvalDate": "string"
  }
}

🟠400Bad Request

🟠401Unauthorized