Skip to main content
PUT
/
api
/
v1
/
provisioning
/
tenants
/
{tenantId}
/
{collection}
/
{docId}
Update a provisioning document (PUT = merge update)
curl --request PUT \
  --url https://platform.crescendo.ai/api/v1/provisioning/tenants/{tenantId}/{collection}/{docId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{}
PUT requests merge fields into an existing document:
  • Only the provided fields are updated
  • Existing fields not mentioned in the payload are preserved
  • If the document does not exist, the API returns 404 NotFound
The API stamps updated (epoch millis) and updatedBy automatically.

​
Example: update a user role

export CRESCENDO_TENANT_ID="tenant-alpha"
export CRESCENDO_API_KEY="YOUR_API_KEY"

curl -sS -X PUT \
  -H "Authorization: Bearer $CRESCENDO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"role":"owner"}' \
  "https://platform.crescendo.ai/api/v1/provisioning/tenants/$CRESCENDO_TENANT_ID/users/user-123"

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
tenantId
string
required

Tenant identifier.

​
collection
string
required

Collection name under the tenant (for example: users, bots, jobs).

​
docId
string
required

Document identifier within the collection.

Body

application/json

Arbitrary JSON object representing the provisioning resource.

Response

Updated

Arbitrary JSON object representing the provisioning resource.