Skip to main content
PATCH
Mark a task as completed

Authorizations

Authorization
string
header
required

OAuth2 access token or static API token. See Authorization for how to obtain one.

Path Parameters

id
string
required

Task identifier

Body

Mark a task as completed

administration_id
string
required

Administration identifier

fields
string

JSON object defining fields to receive (e.g {"only": ["field1", {"field2": ["field3"]}]})

completed_status
string

Completion status of the task (succeeded, failed, cleaned_up)

completed_status_message
string

Message explaining the completion status

comment
string

Comment to add when completing the task

resume_dossiers
boolean

Whether to resume blocked dossiers associated with the task

Response

Task

CustomerApi_V1_TaskEntity model

administration_id
string
required

Owning administration identifier

id
string
required

Unique identifier

expiry_date
string
required

Expiry date of the task

updated_at
string<date-time>
required

Timestamp at which the task was last updated

created_at
string<date-time>
required

Timestamp at which the task was created

assigned_to_user
object

User the task is assigned to

credit_case_id
string

Associated credit_case identifier

debtor_id
string

Associated debtor identifier

invoice_id
string

Associated invoice identifier

description
string

Description of the task

subject
string

Subject of the task

completed_status
enum<string>

Completion status of the task (succeeded, failed, cleaned_up)

Available options:
succeeded,
failed,
cleaned_up
completed_status_message
string

Message explaining the completion status of the task

comments
object[]

Comments (request with the 'fields' parameter)

completed_at
string<date-time>

Timestamp at which the task was completed

Last modified on August 13, 2026