Skip to main content

SetStatusArgs

type SetStatusArgs = {
activeUntil?: Date | string | null;
effects?: | {
pauseActivity?: StatusEffectArgs | null;
pauseNotifications?: StatusEffectArgs | null;
}
| null;
emoji?: string | null;
message?: string | null;
};

Only supplied fields change. Null removes optional fields and effects. A status needs a message, an emoji or both, so the API rejects a call that would leave it with neither.

Properties​

activeUntil?​

optional activeUntil?: Date | string | null;

Must be in the future; null removes expiry, omission preserves it. Dates are sent as ISO strings.


effects?​

optional effects?:
| {
pauseActivity?: StatusEffectArgs | null;
pauseNotifications?: StatusEffectArgs | null;
}
| null;

Supplied effects are merged; null clears all effects, omission or {} preserves them.

Union Members​

Type Literal​
{
pauseActivity?: StatusEffectArgs | null;
pauseNotifications?: StatusEffectArgs | null;
}
NameTypeDescription
pauseActivity?StatusEffectArgs | nullPauses Todoist Karma and streaks. Null removes it; {} preserves its configuration or enables it with defaults.
pauseNotifications?StatusEffectArgs | nullHolds back Comms notifications. Null removes it; {} preserves its configuration or enables it with defaults.

null


emoji?​

optional emoji?: string | null;

message?​

optional message?: string | null;

1 to 80 characters once trimmed. Null removes it, omission preserves it.