PATCH /tenants/{tenantId}/product/{product} – Updates an existing tenant of a specific product.


Headers:

  • Authorization: Bearer <access_token> (required)
  • Content-Type: application/json or application/x-www-form-urlencoded (required)

Body:

  • endpointUrl: The product-specific URL for the tenant. (required as this is the only updatable field)

Path Parameters:

  • tenantId: The ID of the tenant to update. (required)
  • product: The product associated with the tenant. (required)

Query Parameters:

  • None
  • Only the endpointUrl field can be updated. Other fields are immutable.

  • 200 OK – Returns a JSON-stringified Tenant object.

Status Code Meaning When it Happens
400 Bad Request Missing or invalid fields in request body
401 Unauthorized Missing or invalid authentication token
404 Not Found Tenant not found
500 Internal Server Error Unexpected error during tenant update
{
"error": "Detailed error message here"
}

PATCH /tenants/tenant123/product/script
{
"endpointUrl": "https://api.new.example.com"
}
{
"tenantId": "tenant123",
"product": "script",
"domain": "domain.com",
"endpointUrl": "https://api.new.example.com",
}

  • Parameters

    • event: APIGatewayProxyEvent

      The API Gateway event containing the request.

    • context: Context
    • callback: Callback<APIGatewayProxyResult>

    Returns void | Promise<APIGatewayProxyResult>

    A Promise resolving to an API Gateway-compatible response.