Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Users

Create user

Create a new user. After creation, please use "Assign roles" endpoint to grant roles to the user, and "Assign scope" endpoint to assign a scope of permitted properties.

post/users

Request body

emailstring required
emailsstring[]
firstNamestring required
lastNamestring required
titlestring
timezonestring
tagsstring[]
phonestring
phonesstring[]
preferredContactMethodstring
noteBeforeContactingstring
notesstring
customerType'lite' | 'pro'
displayLanguagestring
registrationTypestring
registrationOrigin'SALESFORCE'
country'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BH' | 'BS' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MK' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW'

Country code (ISO 2-letter). Undefined by default unless set by user.

Example request

{
  "picture": {
    "thumbnail": "https://thumbnail.url.com",
    "regular": "https://regular.url.com",
    "large": "https://large.url.com"
  },
  "settings": {
    "notifications": {
      "subscriptions": [
        {
          "type": "PAYMENT",
          "name": "FAILED",
          "targets": [
            "DASHBOARD"
          ]
        }
      ]
    }
  },
  "country": "US",
  "roles": [
    {
      "roleId": "579e1769cf6c3fed6a3f6b1a"
    }
  ]
}

Response

Success response

_idstring

User MongoDB _id

accountIdstring

Your account ID

emailstring
emailsstring[]
firstNamestring
userStartedUpdateEmailFlowboolean
lastNamestring
fullNamestring
titlestring
timezonestring
tagsstring[]
lastActivityTimenumber
phonestring
phonesstring[]
preferredContactMethodstring
noteBeforeContactingstring
notesstring
displayLanguagestring

Example response

{
  "_id": "611d02b7c9c54b01736ae01d",
  "accountId": "611cf837c9c54b01736ae01c",
  "email": "example@email.com",
  "emails": [
    "example@email.com"
  ],
  "firstName": "John",
  "lastName": "Boe",
  "fullName": "John Boe",
  "title": "CTO",
  "timezone": "Europe/Zurich",
  "picture": {
    "thumbnail": "https://thumbnail.url.com",
    "regular": "https://regular.url.com",
    "large": "https://large.url.com"
  },
  "tags": [
    "tag1"
  ],
  "settings": {
    "notifications": {
      "subscriptions": [
        {
          "type": "PAYMENT",
          "name": "FAILED",
          "targets": [
            "DASHBOARD"
          ]
        }
      ]
    }
  }
}