Skip to main content
PATCH
/
organizations
/
{organizationId}
cURL
curl --request PATCH \
  --url https://api.lucidtech.ai/{basePath}/organizations/{organizationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "metadata": {},
  "paymentMethodId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "documentRetentionInDays": 913,
  "planId": "<string>",
  "url": "<string>"
}
'
{
  "metadata": {},
  "numberOfUsersAllowed": 1,
  "monthlyNumberOfPredictionsAllowed": 1,
  "organizationId": "<string>",
  "numberOfModelsCreated": 1,
  "numberOfTransitionsCreated": 1,
  "monthlyNumberOfDocumentsAllowed": 1,
  "monthlyNumberOfTransformationsCreated": 1,
  "createdTime": "<string>",
  "planId": "<string>",
  "monthlyUsageSummary": {},
  "updatedTime": "<string>",
  "monthlyNumberOfGpuHoursUsed": 1,
  "updatedBy": "<string>",
  "monthlyNumberOfWorkflowExecutionsAllowed": 1,
  "monthlyNumberOfActiveModelsUsed": 1,
  "monthlyNumberOfDataBundlesCreated": 1,
  "numberOfUsersCreated": 1,
  "monthlyNumberOfTransitionExecutionsCreated": 1,
  "numberOfSecretsCreated": 1,
  "name": "<string>",
  "monthlyNumberOfTransformationsAllowed": 1,
  "numberOfAppClientsAllowed": 1,
  "numberOfWorkflowsCreated": 1,
  "monthlyNumberOfFieldPredictionsUsed": 1,
  "monthlyNumberOfWorkflowExecutionsCreated": 1,
  "description": "<string>",
  "monthlyNumberOfDataBundlesAllowed": 1,
  "monthlyNumberOfTransitionExecutionsAllowed": 1,
  "numberOfSecretsAllowed": 1,
  "monthlyNumberOfTrainingsCreated": 1,
  "paymentMethodId": "<string>",
  "numberOfAppClientsCreated": 1,
  "numberOfAssetsCreated": 1,
  "numberOfWorkflowsAllowed": 1,
  "documentRetentionInDays": 913,
  "monthlyNumberOfPredictionsCreated": 1,
  "numberOfTransitionsAllowed": 1,
  "monthlyNumberOfDocumentsCreated": 1,
  "numberOfModelsAllowed": 1,
  "createdBy": "<string>",
  "monthlyNumberOfTrainingsAllowed": 1,
  "monthlyNumberOfFieldPredictionsAllowed": 1,
  "numberOfAssetsAllowed": 1,
  "numberOfAgentsCreated": 1,
  "privileges": {},
  "monthlyNumberOfAgentRunsCreated": 1,
  "deploymentsAllowed": {},
  "monthlyNumberOfHookRunsCreated": 1,
  "numberOfHooksCreated": 1,
  "numberOfDatasetsAllowed": 1,
  "numberOfActionsCreated": 1,
  "monthlyNumberOfActionRunsAllowed": 1,
  "monthlyNumberOfValidationTasksCreated": 1,
  "monthlyNumberOfPagePredictionsAllowed": 1,
  "deploymentsCreated": {},
  "numberOfAgentsAllowed": 1,
  "monthlyNumberOfAgentRunsAllowed": 1,
  "pictureUrl": "<string>",
  "monthlyNumberOfActionRunsCreated": 1,
  "numberOfActionsAllowed": 1,
  "numberOfValidationsCreated": 1,
  "monthlyNumberOfProductionWorkflowMinutesUsed": 1,
  "code": "<string>",
  "monthlyNumberOfUserMinutesUsed": 1,
  "numberOfValidationsAllowed": 1,
  "monthlyNumberOfModelDeploymentUnitsUsed": 1,
  "clientId": "<string>",
  "numberOfConnectionsAllowed": 1,
  "numberOfHooksAllowed": 1,
  "monthlyNumberOfHookRunsAllowed": 1,
  "url": "<string>",
  "numberOfDatasetsCreated": 1,
  "monthlyNumberOfPagePredictionsUsed": 1,
  "numberOfConnectionsCreated": 1,
  "monthlyNumberOfValidationTasksAllowed": 1,
  "useNewScopes": true
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
Content-Type
string
required

Path Parameters

​
organizationId
string
required

Body

application/json
​
metadata
object
​
paymentMethodId
string | null
​
name
string | null
Maximum string length: 4096
​
description
string | null
Maximum string length: 4096
​
documentRetentionInDays
integer
Required range: 1 <= x <= 1825
​
planId
string
​
url
string | null
Maximum string length: 4096

Response

200 response

​
metadata
object
required
​
numberOfUsersAllowed
integer
required
Required range: x >= 0
​
monthlyNumberOfPredictionsAllowed
integer
required
Required range: x >= 0
​
organizationId
string
required
​
numberOfModelsCreated
integer
required
Required range: x >= 0
​
numberOfTransitionsCreated
integer
required
Required range: x >= 0
​
monthlyNumberOfDocumentsAllowed
integer
required
Required range: x >= 0
​
monthlyNumberOfTransformationsCreated
integer
required
Required range: x >= 0
​
createdTime
string
required
​
planId
string | null
required
​
monthlyUsageSummary
object
required
​
updatedTime
string | null
required
​
monthlyNumberOfGpuHoursUsed
number
required
Required range: x >= 0
​
updatedBy
string | null
required
Maximum string length: 4096
​
monthlyNumberOfWorkflowExecutionsAllowed
integer
required
Required range: x >= 0
​
monthlyNumberOfActiveModelsUsed
integer
required
Required range: x >= 0
​
monthlyNumberOfDataBundlesCreated
integer
required
Required range: x >= 0
​
numberOfUsersCreated
integer
required
Required range: x >= 0
​
monthlyNumberOfTransitionExecutionsCreated
integer
required
Required range: x >= 0
​
numberOfSecretsCreated
integer
required
Required range: x >= 0
​
name
string | null
required
Maximum string length: 4096
​
monthlyNumberOfTransformationsAllowed
integer
required
Required range: x >= 0
​
numberOfAppClientsAllowed
integer
required
Required range: x >= 0
​
numberOfWorkflowsCreated
integer
required
Required range: x >= 0
​
monthlyNumberOfFieldPredictionsUsed
integer
required
Required range: x >= 0
​
monthlyNumberOfWorkflowExecutionsCreated
integer
required
Required range: x >= 0
​
description
string | null
required
Maximum string length: 4096
​
monthlyNumberOfDataBundlesAllowed
integer
required
Required range: x >= 0
​
monthlyNumberOfTransitionExecutionsAllowed
integer
required
Required range: x >= 0
​
numberOfSecretsAllowed
integer
required
Required range: x >= 0
​
monthlyNumberOfTrainingsCreated
integer
required
Required range: x >= 0
​
paymentMethodId
string | null
required
​
numberOfAppClientsCreated
integer
required
Required range: x >= 0
​
numberOfAssetsCreated
integer
required
Required range: x >= 0
​
numberOfWorkflowsAllowed
integer
required
Required range: x >= 0
​
documentRetentionInDays
integer
required
Required range: 1 <= x <= 1825
​
monthlyNumberOfPredictionsCreated
integer
required
Required range: x >= 0
​
numberOfTransitionsAllowed
integer
required
Required range: x >= 0
​
monthlyNumberOfDocumentsCreated
integer
required
Required range: x >= 0
​
numberOfModelsAllowed
integer
required
Required range: x >= 0
​
createdBy
string
required
Maximum string length: 4096
​
monthlyNumberOfTrainingsAllowed
integer
required
Required range: x >= 0
​
monthlyNumberOfFieldPredictionsAllowed
integer
required
Required range: x >= 0
​
numberOfAssetsAllowed
integer
required
Required range: x >= 0
​
numberOfAgentsCreated
integer
Required range: x >= 0
​
privileges
object
​
monthlyNumberOfAgentRunsCreated
integer
Required range: x >= 0
​
deploymentsAllowed
object
​
monthlyNumberOfHookRunsCreated
integer
Required range: x >= 0
​
numberOfHooksCreated
integer
Required range: x >= 0
​
numberOfDatasetsAllowed
integer
Required range: x >= 0
​
numberOfActionsCreated
integer
Required range: x >= 0
​
monthlyNumberOfActionRunsAllowed
integer
Required range: x >= 0
​
monthlyNumberOfValidationTasksCreated
integer
Required range: x >= 0
​
monthlyNumberOfPagePredictionsAllowed
integer
Required range: x >= 0
​
deploymentsCreated
object
​
numberOfAgentsAllowed
integer
Required range: x >= 0
​
monthlyNumberOfAgentRunsAllowed
integer
Required range: x >= 0
​
pictureUrl
string | null
​
monthlyNumberOfActionRunsCreated
integer
Required range: x >= 0
​
numberOfActionsAllowed
integer
Required range: x >= 0
​
numberOfValidationsCreated
integer
Required range: x >= 0
​
monthlyNumberOfProductionWorkflowMinutesUsed
integer
Required range: x >= 0
​
code
string | null
Maximum string length: 4096
​
monthlyNumberOfUserMinutesUsed
number
Required range: x >= 0
​
numberOfValidationsAllowed
integer
Required range: x >= 0
​
monthlyNumberOfModelDeploymentUnitsUsed
integer
Required range: x >= 0
​
clientId
string | null
​
numberOfConnectionsAllowed
integer
Required range: x >= 0
​
numberOfHooksAllowed
integer
Required range: x >= 0
​
monthlyNumberOfHookRunsAllowed
integer
Required range: x >= 0
​
url
string | null
Maximum string length: 4096
​
numberOfDatasetsCreated
integer
Required range: x >= 0
​
monthlyNumberOfPagePredictionsUsed
integer
Required range: x >= 0
​
numberOfConnectionsCreated
integer
Required range: x >= 0
​
monthlyNumberOfValidationTasksAllowed
integer
Required range: x >= 0
​
useNewScopes
boolean