Update an account

Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH/v3/accounts/{id}

JWT

account:write

Parameters

Name	Type	In	Description
id*	string	path	Unique identifier for the account.

Request Body Schema

Property	Type	Description	Constraints
email	string	Email address of the company.	format: email
company	string	Name of the company.	min: 1, max: 256
accountAlias	string	Unique account alias.	min: 2, max: 256, pattern: ^[a-zA-Z0-9_-]+$
website	string	Website of the company.	min: 0, max: 256, format: uri
logoUrl	string	Logo url.	min: 0, max: 256, format: uri
faviconUrl	string	Favicon url.	min: 0, max: 256, format: uri
googleClientId	string	Google client id.	min: 0, max: 256

Request Example

{
  "email": "user@example.com",
  "company": "string",
  "accountAlias": "a",
  "website": "http://example.com",
  "logoUrl": "http://example.com",
  "faviconUrl": "http://example.com",
  "googleClientId": "string"
}

Triggers webhook: account.updated

POST <your-webhook-url>
{
  "event": "account.updated",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "company": "string",
    "email": "string",
    "status": "active",
    "adminPortalDomain": "string",
    "customerPortalDomain": "string",
    "resellerPortalDomain": "string",
    "website": "string",
    "logoUrl": "string",
    "faviconUrl": "string",
    "googleClientId": "string",
    "trialExpiresAt": "2019-08-24T14:15:22Z",
    "plan": {
      "id": "string",
      "name": "string",
      "displayName": "string",
      "version": 0,
      "tier": 0,
      "interval": "string",
      "paddleId": "string",
      "paddlePriceId": "string",
      "allowedUsers": 0,
      "allowedOrganizations": 0,
      "allowedAdmins": 0,
      "allowedProducts": 0,
      "allowedMeterAttributes": 0,
      "allowedFeatureFlags": 0,
      "allowedFeatures": 0,
      "allowedActivations": 0,
      "allowedTrialActivations": 0,
      "allowedReleases": 0,
      "allowedProductSpace": 0,
      "allowSendingDomain": true,
      "amount": "string",
      "allowCustomerPortalAccess": true,
      "allowOrganizationAdmins": true,
      "allowOfflineActivations": true,
      "allowHostedFloatingLicenses": true,
      "allowOnPremiseFloatingLicenses": true,
      "allowCustomDomain": true,
      "allowResellers": true,
      "allowSso": true,
      "allowCustomRoles": true,
      "allowLegacyCustomRoles": true,
      "allowEventLogs": true,
      "allowAuditLogs": true,
      "allowCustomEmailTemplates": true,
      "allowMaintenancePolicies": true,
      "allowActivationLogs": true,
      "activationLogsRetentionPeriod": "string",
      "deprecated": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    },
    "companyId": "string",
    "accountAlias": "string",
    "region": "string",
    "paymentMethod": "string",
    "psp": "string",
    "totalTrialExtensions": 0
  },
  "triggeredAt": "string"
}

Responses

200

400

401

403

404

429

500

200 OK

{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "company": "string",
  "email": "string",
  "status": "active",
  "adminPortalDomain": "string",
  "customerPortalDomain": "string",
  "resellerPortalDomain": "string",
  "website": "string",
  "logoUrl": "string",
  "faviconUrl": "string",
  "googleClientId": "string",
  "trialExpiresAt": "2019-08-24T14:15:22Z",
  "plan": {
    "id": "string",
    "name": "string",
    "displayName": "string",
    "version": 0,
    "tier": 0,
    "interval": "string",
    "paddleId": "string",
    "paddlePriceId": "string",
    "allowedUsers": 0,
    "allowedOrganizations": 0,
    "allowedAdmins": 0,
    "allowedProducts": 0,
    "allowedMeterAttributes": 0,
    "allowedFeatureFlags": 0,
    "allowedFeatures": 0,
    "allowedActivations": 0,
    "allowedTrialActivations": 0,
    "allowedReleases": 0,
    "allowedProductSpace": 0,
    "allowSendingDomain": true,
    "amount": "string",
    "allowCustomerPortalAccess": true,
    "allowOrganizationAdmins": true,
    "allowOfflineActivations": true,
    "allowHostedFloatingLicenses": true,
    "allowOnPremiseFloatingLicenses": true,
    "allowCustomDomain": true,
    "allowResellers": true,
    "allowSso": true,
    "allowCustomRoles": true,
    "allowLegacyCustomRoles": true,
    "allowEventLogs": true,
    "allowAuditLogs": true,
    "allowCustomEmailTemplates": true,
    "allowMaintenancePolicies": true,
    "allowActivationLogs": true,
    "activationLogsRetentionPeriod": "string",
    "deprecated": true,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "companyId": "string",
  "accountAlias": "string",
  "region": "string",
  "paymentMethod": "string",
  "psp": "string",
  "totalTrialExtensions": 0
}