Function: patchActivitiesById()

patchActivitiesById<ThrowOnError>(options): RequestResult<PatchActivitiesByIdResponses, PatchActivitiesByIdErrors, ThrowOnError>

Defined in: app/api/sdk.gen.ts:68

Partially updates a specific activity by its unique identifier using a JSON Patch document. The PatchActivity endpoint allows clients to submit a request to modify an existing activity by providing a JSON Patch document that specifies the changes to be made to the activity's properties. This endpoint is designed to handle partial updates of activities, ensuring that the provided patch document is validated and applied correctly, while also enforcing proper authorization to ensure that only authorized users can modify existing activities within the system. Upon successful application of the patch, the endpoint returns a 204 No Content status code, indicating that the activity has been successfully updated without returning any content in the response body. This approach allows for efficient updates to activity data without requiring clients to send the entire activity object, enabling more flexible and targeted modifications to activity properties as needed.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<PatchActivitiesByIdData, ThrowOnError>

Returns

RequestResult<PatchActivitiesByIdResponses, PatchActivitiesByIdErrors, ThrowOnError>