Partially Update an Analysis Group

Partially update an existing Analysis Group.

Request

HTTP Request

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

Path Parameters

Parameter	Description
group_id	An existing Beam Analysis Group ID.

Request Headers

Header	Value
Content-Type	application/json

Request Body

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

Remember this is a PATCH endpoint which means only the fields you provide will be updated.

If you wish to replace all fields please use the PUT endpoint.

Response

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

Examples

curl

curl -X PATCH "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",
    }
    EOF
    )  

python

import requests

response = requests.patch(
    url="https://api.predicthq.com/v1/beam/analysis-groups/$GROUP_ID",
    headers={
        "Authorization": "Bearer $ACCESS_TOKEN",
        "Accept": "application/json"
    },
    json={
        "name": "Analysis Group 2"
    }
)

print(response.status_code)