myCC - Users

Adds a new user to a myCC account

When a user is excluded from receiving an email invite, the user is registered in Kelowna, but not externally.

post/Accounts/{accountId}/Users

Request

  • Base URL: https://api.carboncure.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.carboncure.com/Accounts/{accountId}/Users
  • Auth: one of:
    • none
    • OAuth 2 (authorization code, authorization URL https://auth.carboncure.com/oauth2/authorize, token URL https://auth.carboncure.com/oauth2/token, scopes: applicationId, roles)
    • none

Path parameters

accountIdinteger required

The ID of the myCC account

Query parameters

shouldExcludeFromInviteboolean

Indicates whether the user should be invited to set a password.

Request body

emailstring nullable
firstNamestring nullable
lastNamestring nullable
permissionGroup'Staff' | 'Manager' | 'Admin'
jobTitlestring nullable
jobFieldstring[] nullable
phonestring nullable
primaryContactType'Owner' | 'QcManager' | 'Operations' | 'ItContact' | 'Other'
isPrimaryContactboolean nullable
photoUrlstring nullable
repTypestring[] nullable

Response

OK

userIdinteger
emailstring nullable
firstNamestring nullable
lastNamestring nullable
isDisabledboolean
naiveFullNamestring nullable
externalUserIdstring nullable
wasInviteSentboolean
isRegisteredInFusionAuthboolean
jobTitlestring nullable
jobFieldstring[] nullable
phonestring nullable
language'English' | 'Spanish' | 'NL' | 'FR' | 'DE' | 'IT' | 'ES' | 'ES_MX' | 'PT' | 'PT_BR' | 'JP' | 'ZH_TW' | 'ZH_CN' | 'KO' | 'ID' | 'EN_GB' | 'EN_US' | 'EN_CA' | 'TL' | 'TH'
numericFormatstring nullable
allowsFunctionalCookiesboolean nullable
allowsAnalyticsCookiesboolean nullable
enviroContactNamestring nullable
enviroContactPhonestring nullable
enviroContactEmailstring nullable
enviroContactWebsitestring nullable
settingsChangedTimestampstring date-time nullable
policiesAcceptedTimestampstring date-time nullable
lastActivityTimestampstring date-time nullable

The time of the latest activity by this user in myCarbonCure

wantsNewFeatureEmailboolean
wantsPositionEmailboolean
wantsTestingEmailboolean
wantsCreditProgramEmailboolean
permissionGroup'Staff' | 'Manager' | 'Admin'
primaryContactType'Owner' | 'QcManager' | 'Operations' | 'ItContact' | 'Other'
isPrimaryContactboolean
myCCAccountIdinteger

Changes

No recorded changes to this operation across all 1 revision of this API.