Update an Analysis Group

Update (replace) an existing Analysis Group.

Request

HTTP Request

PUT https://api.predicthq.com/v1/beam/analysis-groups/$group_id

Path Parameters

ParameterDescription

group_id

An existing Beam Analysis Group ID.

Request Headers

HeaderValue

Content-Type

application/json

Request Body

This endpoint accepts the same request body fields as the Create an Analysis Group endpoint. Please refer to the Create an Analysis Group documentation for request body parameters.

Remember this is a PUT endpoint which means you must provide all supported fields - you are effectively replacing the existing record with a new record containing all the fields you provide. We recommend first getting the existing record and pre-populating the request body with the current values, then change the fields you need to change.

Response

If successful, the HTTP response code will be 202 Accepted.

Examples

curl -X PUT "https://api.predicthq.com/v1/beam/analysis-groups/$GROUP_ID" \
     -H "Accept: application/json" \
     -H "Authorization: Bearer $ACCESS_TOKEN" \
     --data @<(cat <<EOF
    {
        "name": "Analysis Group 2",
        "analysis_ids": [
            "zRa_kk7MlAA",
            "Wfjj1_PCArw"
        ]
    }
    EOF
    )

Last updated

© 2024 PredictHQ Ltd