Organizations

Update an Organization

This endpoint allows you to update an Organization.

Note: passwordPolicy settings are only used when passwordCompliance is set to "custom". We discourage the use of non-custom passwordCompliance values.

emailDisclaimer can only be modified by paying customers.

hasStripeCustomerId is deprecated and will be removed.

Sample Request

curl -X PUT https://console.jumpcloud.com/api/organizations/{OrganizationID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
  "settings": {
    "contactName": "Admin Name",
    "contactEmail": "admin@company.com",
    "systemUsersCanEdit":true,
    "passwordPolicy": {
      "enableMaxHistory": true,
      "maxHistory": 3
    }
  }
}'
put/organizations/{id}

Request

Request body

Example request

{
  "settings": {
    "trustedAppConfig": {
      "trustedApps": [
        {
          "name": "Application 1",
          "path": "/someuser/Applications/application1.app",
          "teamid": "FakeTeamID"
        }
      ]
    }
  }
}

Response

OK

_idstring
createdstring
displayNamestring
hasStripeCustomerIdboolean
hasCreditCardboolean
lastEstimateCalculationTimeStampstring
lastSfdcSyncStatusobject
accountsReceivablestring
accessRestrictionstring
accountType'Alliance' | 'Distributor' | 'MSP' | 'VAR' | 'Direct' | 'Indirect' | 'Tenant' | 'Deleted Organization' | 'Partner' | 'Customer' | 'Prospective Customer' | 'Prospective Partner'

Salesforce Account Type (Account_Type__c) written back to the org via BSS sync. Returned only when requested via the fields query parameter.

logoUrlstring nullable
providerstring nullable
totalBillingEstimateinteger

Example response

{
  "settings": {
    "trustedAppConfig": {
      "checksum": "thisIsAnExampleChecksum1234",
      "trustedApps": [
        {
          "name": "Application 1",
          "path": "/someuser/Applications/application1.app",
          "teamid": "FakeTeamID"
        }
      ]
    }
  }
}

Changes

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