Partially Update an Analysis

Partially update an existing Analysis.

Request

HTTP Request

PATCH https://api.predicthq.com/v1/beam/analyses/

Path Parameters

Parameter	Description
analysis_id	An existing Beam Analysis 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 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 204 No Content.

Examples

curl

curl -X PATCH "https://api.predicthq.com/v1/beam/analyses/$ANALYSIS_ID" \
     -H "Accept: application/json" \
     -H "Authorization: Bearer $ACCESS_TOKEN" \
     --data @<(cat <<EOF
    {
        "name": "Analysis 2",
    }
    EOF
    )  

python

import requests

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

print(response.status_code)

Guides

Below are some guides relevant to this API:

• https://github.com/predicthq/gitbook-tech-docs/blob/main/docs/getting-started/guides/beam-guides/README.md