Update a Manager User

Update details for a user with a Manager role (BA_MANAGER). The BA_ADMIN or BA_MANAGER role is required to call this API.

Endpoint

PUT /v1/accounts/{accountId}/users/{userId}

Authorization Header

Authorization: Bearer <access_token>
or
Authorization: Basic <encodedString>
where <encodedString> is your <api-key>:<api-secret> string encoded using Base64 encoding

Path Parameters

accountId REQUIRED

string

ID of the RocketCOMS Business Account that the user belongs to.

userId REQUIRED

string (UUID)

Unique ID assigned to the user in RocketCOMS.

Request Body

addressType

string, max length: 10, min length: 0

Address type. (Examples: Work, Home)

streetLine1

string, max length: 255, min length: 0

Address line 1.

zipCode

string, max length: 10, min length: 0

ZIP code or postal code.

countryCode

string, max length: 10, min length: 0

ISO 2-character country code. For example, use US for the United States.

stateCode

string, max length: 10, min length: 0

State or province. 2-character codes are required for the United States (for example, use CA for California).

cityName

string, max length: 50, min length: 0

City name.

firstName

string

User’s first name.

title

string

User’s title. (Examples: Mr., Mrs., Dr., Ms.)

signatory

boolean

Whether the user is an authorized signatory for the Business Account.

lastName

string

User’s last name.

middleName

string

User’s middle name.

string

User’s email address.

mobileNumber

string

User’s mobile number.

Returns

If successful, returns 200 BA Manager updated successfully.

SAMPLE REQUEST

				
					{
  "mobileNumber": "+15555556789"
}

SAMPLE RESPONSE

				
					{
  200 BA Manager updated successfully
}