Skip to main content
PUT
Update CoworkerBookingCreditUseHistory
Updates an existing CoworkerBookingCreditUseHistory record. You must include the Id of the record to update along with all required fields.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the CoworkerBookingCreditUseHistory-Edit role.

Request Body

Required Fields

integer
required
The Id of the CoworkerBookingCreditUseHistory record to update.
integer
required
ID of the booking credit that was consumed.
number
required
Amount of credit consumed by this entry.

Optional Fields

string
Optional description or note for this credit use entry.
integer
ID of the booking this credit was applied to, if the credit was used for a booking.
integer
ID of the invoice line this credit was applied to, if the credit was used against an invoice.
integer
ID of the event attendance record this credit was applied to, if the credit was used for an event.

Code Examples

Response

200

integer
HTTP status code. 200 on success.
string
A human-readable message confirming the update.
object
Contains the Id of the updated record.
boolean
true if the coworkerbookingcreditusehistory was updated successfully.
array
null on success.
Example Response

400

string
A summary of the validation error(s), in the format PropertyName: error message.
any
null on validation failure.
object[]
Array of validation errors.
boolean
false when the request fails validation.
Example Response