Skip to content
PIE V2 API

Update a client

PUT
/v2/clients/{client_id}
 
curl --request PUT \
  --url https://staging-pie.streamline.enterprises/v2/clients/client-1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
client_id
required
string
Example 
client-1

Request Body

Section titled “Request Body ”
Media type application/json
object
name
string
Example generated
{
  "name": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Client updated

Media type application/json
object
client_id
required
string
client_uuid
required
string format: uuid
name
required
string
status
required
string
Allowed values: active suspended
created_at
required
string format: date-time
updated_at
required
string format: date-time
Example 
{
  "client_id": "client-1",
  "client_uuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
  "name": "Example Client",
  "status": "active",
  "created_at": "2025-01-15T10:00:00Z",
  "updated_at": "2025-01-15T10:00:00Z"
}

400

Section titled “400 ”

Validation error — malformed input, invalid path parameters, or request that fails syntactic validation.

Media type application/json
object
success
required
boolean
message
required

Human-readable error message

string
Example 
{
  "success": false
}

401

Section titled “401 ”

Missing or invalid Authorization bearer token, expired token, or token rejected by the authorization layer (e.g. API Gateway JWT authorizer or application validation).

Media type application/json
object
success
required
boolean
message
required

Human-readable error message

string
Example 
{
  "success": false
}

403

Section titled “403 ”

Authenticated caller lacks the permission required for this operation.

Media type application/json
object
success
required
boolean
message
required

Human-readable error message

string
Example 
{
  "success": false
}

404

Section titled “404 ”

Requested resource was not found.

Media type application/json
object
success
required
boolean
message
required

Human-readable error message

string
Example 
{
  "success": false
}

422

Section titled “422 ”

Semantically invalid request — e.g. domain not active, no model assigned, feature contract mismatch, or invalid feature definitions.

Media type application/json
object
success
required
boolean
message
required

Human-readable error message

string
Example 
{
  "success": false
}