TaskLists
Update TaskList
Update an existing TaskList record.
PUT
Update TaskList
Updates an existing TaskList 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 TaskList-Edit role.Request Body
Required Fields
integer
required
The Id of the TaskList record to update.
integer
required
ID of the business linked to this record.
string
required
The name value for this task list.
Optional Fields
boolean
Whether this task list is currently active.
integer[]
List of tariffs linked to this record.
integer[]
The added tariffs value for this task list.
integer[]
The removed tariffs value for this task list.
boolean
Whether assign to new contacts is enabled.
boolean
Whether assign to new members is enabled.
boolean
Whether assign to cancellations is enabled.
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 tasklist 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
Update TaskList