Create a Manager User
Create a user with a Manager role (BA_MANAGER) for a Business Account. The user’s name, email, and business address are required. The BA_ADMIN role is required to call this API.
Endpoint
POST /v1/accounts/{accountId}/users
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.
Request Body
addressType REQUIRED
string, max length: 10, min length: 0
Address type. (Examples: Work, Home)
streetLine1 REQUIRED
string, max length: 255, min length: 0
Address line 1.
zipCode REQUIRED
string, max length: 10, min length: 0
ZIP code or postal code.
countryCode REQUIRED
string, max length: 10, min length: 0
ISO 2-character country code. For example, use US for the United States.
stateCode REQUIRED
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 REQUIRED
string, max length: 50, min length: 0
City name.
firstName REQUIRED
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 REQUIRED
string
User’s last name.
middleName
string
User’s middle name.
email REQUIRED
string
User’s email address.
mobileNumber
string
User’s mobile number.
Returns
If successful, returns 200 BA Manager created successfully.
SAMPLE REQUEST
{
"addressType": "Work",
"streetLine1": "456 King St",
"zipCode": "10001",
"countryCode": "US",
"stateCode": "NY",
"cityName": "New York"
"firstName": "John",
"title": "Mr.",
"signatory": true,
"lastName": "Doe",
"middleName": "Allan",
"email": "abc@business.com",
"mobileNumber": "+15555551234",
}
SAMPLE RESPONSE
{
200 BA Manager created successfully
}