NOnomba
Accounts

Update access to account

Changed on

You can use this endpoint to update the access of an api client within an account.

put/v1/accounts/{subAccountId}/access

Request

  • Base URL
    https://api.nomba.com
  • URL
    https://api.nomba.com/v1/accounts/{subAccountId}/access
  • Auth
    HTTP bearer

Path parameters

subAccountIdstring uuid required

The account, where client access is to be updated.

Headers

accountIdstring uuid required
Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27

The parent accountId of the business.

Request body

grantType'allow' | 'deny' required

The action to perform on the access

clientIdstring required

The client to grant/deny access to the account

role'ACCOUNT_WRITER' | 'ACCOUNT_READER' required

The role to assume within the account

Example request

{
  "grantType": "allow",
  "clientId": "09132aea-367f-447d-9d9b-46af5a319318",
  "role": "ACCOUNT_WRITER"
}

Response

OK - your request was successful.

codestring required

Response Code

descriptionstring required

Response description

Example response

{
  "code": "00",
  "description": "Success",
  "data": {
    "data": {
      "name": "M.A Animashaun",
      "age": 30,
      "city": "Example City"
    }
  }
}

Changes