API reference

Support desk

How your support desk is set up: its settings, whether it is online, and its numbers.

Base URL https://partners.monotree.com/api/v1 · every call needs a token

Get support stats

get /support/stats support:read

The numbers of your support desk over a period, as the Stats tab in the portal shows them: new and solved threads, first-answer and solving times, topics, ratings, what became of the assistant's drafts, and what went to Monotree. Every number has a name that stays; labels are in English. A share is a whole percentage, or null where there is nothing to take a share of. A thread you started yourself counts once the customer has written in it; threads dismissed by the desk itself are left out.

Parameters

days

integer · query

The period: 1 today, -1 yesterday, 7, 30 or 90 days up to and including today, 0 all time.

one of 1, -1, 7, 30, 90, 0 · default 30

customer

string · query

Only the numbers of this customer: its ID, or external_ref: and your own reference.
Response · 200 The numbers.

object

string

days

integer

The period asked for.

one of 1, -1, 7, 30, 90, 0

span_days

integer

How many days the period covers. For all time, the days since your first thread.

from

string

to

string

kpis

array of objects

The six headline numbers, always in the order new, solved, response, solving, unchanged, drafted.

facts

object

threads_per_day

number

New threads per day of the period, to one decimal.

escalated_share_percent

integer, nullable

New threads that were escalated to Monotree.

no_reply_needed_share_percent

integer, nullable

reopened_share_percent

integer, nullable

auto_replies

integer

New threads that got the automatic reply.

oldest_waiting_minutes

integer, nullable

How long the oldest open thread has waited for you, as of now. Null where none waits.

urgent

integer

New threads that are urgent.

daily

array of objects

Each day of the period, oldest first, at most the last 90.

channels

array of objects

New threads by channel. key is chat or email.

kinds

array of objects

New threads by kind. key is a kind, or unread for threads the assistant has not read.

topics

array of objects

What customers ask about, by tag, most first, and where the help fell short.

ratings

object

asked

integer

Threads where the customer was asked whether the answer helped.

rated

integer

answered_share_percent

integer, nullable

rated as a share of asked.

positive

integer

negative

integer

helpful_share_percent

integer, nullable

positive as a share of rated.

negative_threads

array of objects

The six latest threads rated negative.

customers

array of objects

The eight customers who wrote most. key is the customer's ID (cus_…), label its company name.

draft_outcomes

array of objects

What became of the assistant's drafts. key is sent_unchanged, edited, replaced, no_reply_accepted or discarded; all five rows are always there.

draft_versions

object

sent

array of objects

Which version of a draft was the one sent. key is 1, 2, 3, or 4 for a fourth or later.

with_questions

integer

Drafts that came with questions for you.

questions_answered

integer

Drafts made from an answer to such questions.

escalations

array of objects

Threads handed to Monotree. key is created (a new escalation) or duplicate (added to one already sent).

waiting_ages

array of objects

How long the threads that wait for you now have waited, in five rows. key is under_1h, 1h_to_4h, 4h_to_24h, 1d_to_3d or over_3d. Not bound to the period.

started_by_hour

object

grid

array of arrays

Seven rows, Monday first, of 24 counts: new threads started in that hour of the day in your desk's time zone.

max

integer

The largest count in the grid, at least 1.

staff

array of objects

Answers sent from the portal per person, the eight who sent most. key is the seller's ID (sel_…), label their name. Answers sent over the API are not counted.

assistant

object

drafts

integer

Drafts written in the period.

failed

integer

threads

integer

Threads they were written for.

drafts_per_thread

number, nullable

median_seconds

integer, nullable

How long a draft takes the assistant.

Errors

401 invalid_token: the token is missing, revoked or expired.
403 insufficient_ability: the token lacks the ability this call needs.
404 not_found: no such customer for your company and mode.
422 validation_error: days is not one of the six periods.
429 rate_limited: too many requests. The general limit is 120 requests a minute for all your tokens of one mode (live or sandbox) together, and 300 a minute per IP address before the token is checked. Some calls have a lower limit of their own, which counts only calls that did what they ask (a call refused with another error uses up no place); the Rate limits guide lists them. Wait for the number of seconds in the Retry-After header.
curl https://partners.monotree.com/api/v1/support/stats \
  -H "Authorization: Bearer $MONOTREE_TOKEN"
200 · Response
{
    "object": "support_stats",
    "days": 7,
    "span_days": 7,
    "from": "2026-11-08",
    "to": "2026-11-14",
    "kpis": [
        {
            "key": "new",
            "label": "New threads",
            "unit": "threads",
            "value": 3,
            "today": 3,
            "before": 0,
            "change_percent": null,
            "higher_is_better": null,
            "series": [
                0,
                0,
                0,
                0,
                0,
                0,
                3
            ]
        },
        {
            "key": "solved",
            "label": "Solved",
            "unit": "threads",
            "value": 0,
            "today": 0,
            "before": 0,
            "change_percent": null,
            "higher_is_better": true,
            "series": [
                0,
                0,
                0,
                0,
                0,
                0,
                0
            ]
        },
        {
            "key": "response",
            "label": "First answer, median",
            "unit": "minutes",
            "value": 0,
            "today": null,
            "before": null,
            "change_percent": null,
            "higher_is_better": false,
            "series": []
        },
        {
            "key": "solving",
            "label": "Solved in, median",
            "unit": "minutes",
            "value": null,
            "today": null,
            "before": null,
            "change_percent": null,
            "higher_is_better": false,
            "series": []
        },
        {
            "key": "unchanged",
            "label": "Drafts sent unchanged",
            "unit": "percent",
            "value": 0,
            "today": null,
            "before": null,
            "change_percent": null,
            "higher_is_better": true,
            "series": []
        },
        {
            "key": "drafted",
            "label": "Drafts by the assistant",
            "unit": "drafts",
            "value": 8,
            "today": 8,
            "before": 0,
            "change_percent": null,
            "higher_is_better": null,
            "series": [
                0,
                0,
                0,
                0,
                0,
                0,
                8
            ]
        }
    ],
    "facts": {
        "threads_per_day": 0.4,
        "escalated_share_percent": 100,
        "no_reply_needed_share_percent": 33,
        "reopened_share_percent": 33,
        "auto_replies": 3,
        "oldest_waiting_minutes": null,
        "urgent": 0
    },
    "daily": [
        {
            "day": "2026-11-13",
            "new": 0,
            "solved": 0,
            "drafted": 0,
            "channels": {
                "chat": 0,
                "email": 0
            }
        },
        {
            "day": "2026-11-14",
            "new": 3,
            "solved": 0,
            "drafted": 8,
            "channels": {
                "chat": 2,
                "email": 1
            }
        }
    ],
    "channels": [
        {
            "key": "chat",
            "label": "Chat",
            "count": 2,
            "share_percent": 67
        },
        {
            "key": "email",
            "label": "E-mail",
            "count": 1,
            "share_percent": 33
        }
    ],
    "kinds": [
        {
            "key": "bug",
            "label": "Bug",
            "count": 1,
            "share_percent": 33
        },
        {
            "key": "other",
            "label": "Other",
            "count": 1,
            "share_percent": 33
        },
        {
            "key": "question",
            "label": "Question",
            "count": 1,
            "share_percent": 33
        }
    ],
    "topics": [
        {
            "tag_id": null,
            "label": "No topic",
            "count": 2,
            "before": null,
            "change_percent": null,
            "unsure_share_percent": 0,
            "rewritten": 0,
            "fell_short_share_percent": 0,
            "handed_to_person_share_percent": 0,
            "escalated_share_percent": 100,
            "negative_ratings": 0
        },
        {
            "tag_id": 1,
            "label": "Invitations",
            "count": 1,
            "before": 0,
            "change_percent": null,
            "unsure_share_percent": 100,
            "rewritten": 0,
            "fell_short_share_percent": 100,
            "handed_to_person_share_percent": 0,
            "escalated_share_percent": 100,
            "negative_ratings": 0
        }
    ],
    "ratings": {
        "asked": 0,
        "rated": 0,
        "answered_share_percent": null,
        "positive": 0,
        "negative": 0,
        "helpful_share_percent": null,
        "negative_threads": []
    },
    "customers": [
        {
            "key": "Boulangerie Martin",
            "label": "Boulangerie Martin",
            "count": 2,
            "share_percent": 67
        },
        {
            "key": "Le Petit Bistrot",
            "label": "Le Petit Bistrot",
            "count": 1,
            "share_percent": 33
        }
    ],
    "draft_outcomes": [
        {
            "key": "sent_unchanged",
            "label": "Sent as it was",
            "count": 0,
            "share_percent": 0
        },
        {
            "key": "edited",
            "label": "Sent after an edit",
            "count": 1,
            "share_percent": 33
        },
        {
            "key": "replaced",
            "label": "Replaced by own answer",
            "count": 0,
            "share_percent": 0
        },
        {
            "key": "no_reply_accepted",
            "label": "Nothing to answer",
            "count": 1,
            "share_percent": 33
        },
        {
            "key": "discarded",
            "label": "Not used",
            "count": 1,
            "share_percent": 33
        }
    ],
    "draft_versions": {
        "sent": [
            {
                "key": "1",
                "label": "The first draft",
                "count": 0,
                "share_percent": 0
            },
            {
                "key": "2",
                "label": "The second",
                "count": 1,
                "share_percent": 100
            },
            {
                "key": "3",
                "label": "The third",
                "count": 0,
                "share_percent": 0
            },
            {
                "key": "4",
                "label": "A fourth or later",
                "count": 0,
                "share_percent": 0
            }
        ],
        "with_questions": 4,
        "questions_answered": 1
    },
    "escalations": [
        {
            "key": "created",
            "label": "New escalation",
            "count": 1,
            "share_percent": 33
        },
        {
            "key": "duplicate",
            "label": "Added to one sent",
            "count": 2,
            "share_percent": 67
        }
    ],
    "waiting_ages": [
        {
            "key": "Under an hour",
            "label": "Under an hour",
            "count": 0,
            "share_percent": null
        },
        {
            "key": "1 to 4 hours",
            "label": "1 to 4 hours",
            "count": 0,
            "share_percent": null
        },
        {
            "key": "4 to 24 hours",
            "label": "4 to 24 hours",
            "count": 0,
            "share_percent": null
        },
        {
            "key": "1 to 3 days",
            "label": "1 to 3 days",
            "count": 0,
            "share_percent": null
        },
        {
            "key": "Over 3 days",
            "label": "Over 3 days",
            "count": 0,
            "share_percent": null
        }
    ],
    "started_by_hour": {
        "grid": [
            [
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0
            ],
            [
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0
            ],
            [
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0
            ],
            [
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0
            ],
            [
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0
            ],
            [
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                3,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0
            ],
            [
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0
            ]
        ],
        "max": 3
    },
    "staff": [],
    "assistant": {
        "drafts": 8,
        "failed": 0,
        "threads": 3,
        "drafts_per_thread": 2.7,
        "median_seconds": 17
    }
}

Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.

Sending…

                    

Get the desk's settings

get /support/settings support:configure

How your support desk is set up: the same settings as the Settings tab of the Support page. A sandbox token reads and changes a sandbox desk of its own, which only threads of sandbox customers go by.

Response · 200 The settings.

object

string

auto_draft

boolean

Whether the assistant drafts when a customer writes. Off: only when you ask for a draft.

auto

string

How much the assistant does by itself. off: it drafts for a thread's messages until your desk has answered once. drafts: for every message of theirs. sends: it also sends the drafts it is highly sure of; the rest wait for a person, with needs_person set on the thread, and no automatic reply is sent.

one of off, drafts, sends

auto_reply

boolean

Answer a thread that starts while the desk is offline, once, with auto_reply_text.

timezone

string

An IANA time zone name. The office hours are in it.

hours

object

The office hours per day, on the 24 hour clock in the desk's timezone: [opens, closes], or null for a closed day.

mon

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

tue

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

wed

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

thu

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

fri

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

sat

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

sun

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

holidays

string, nullable

The country whose public holidays the desk is closed on. Null for none.

one of FR, ES, IT, BE, DK

holidays_extra

array of strings

More days the desk is closed. Returned in order, each once.

auto_reply_text

string

{next_open} becomes when the desk opens next, such as "tomorrow at 09:00".

at least 1 characters · at most 600 characters

staff_language

string

The language your people read the assistant's advice and translations in.

one of en, fr, es, it, de, nl, da

debug

boolean

Show how the assistant worked on a draft in the portal.

reopen_days

integer

A closed thread opens again when the customer writes within this many days; after that a new thread starts. 0: always a new thread.

from 0 · up to 90

idle_close_days

integer

After how many days without a message a thread that waits for the customer is closed by itself, with resolution no_response. Checked once a day; a snoozed thread is left alone until it wakes. If they write again within reopen_days, the thread opens again.

from 1 · up to 90

signature

boolean

End chat answers with the first name of the person who wrote them. Mail always is. A thread can say otherwise (signed).

ask_rating

boolean

Ask the customer whether the answer helped when a chat is closed.

Errors

401 invalid_token: the token is missing, revoked or expired.
403 insufficient_ability: the token lacks the ability this call needs.
429 rate_limited: too many requests. The general limit is 120 requests a minute for all your tokens of one mode (live or sandbox) together, and 300 a minute per IP address before the token is checked. Some calls have a lower limit of their own, which counts only calls that did what they ask (a call refused with another error uses up no place); the Rate limits guide lists them. Wait for the number of seconds in the Retry-After header.
curl https://partners.monotree.com/api/v1/support/settings \
  -H "Authorization: Bearer $MONOTREE_TOKEN"
200 · Response
{
    "object": "support_settings",
    "auto_draft": true,
    "auto": "off",
    "auto_reply": true,
    "timezone": "Europe/Paris",
    "hours": {
        "mon": [
            "09:00",
            "18:00"
        ],
        "tue": [
            "09:00",
            "18:00"
        ],
        "wed": [
            "09:00",
            "18:00"
        ],
        "thu": [
            "09:00",
            "18:00"
        ],
        "fri": [
            "09:00",
            "18:00"
        ],
        "sat": null,
        "sun": null
    },
    "holidays": "FR",
    "holidays_extra": [],
    "auto_reply_text": "Thanks for your message. We are closed right now and will answer {next_open}.",
    "staff_language": "en",
    "debug": false,
    "reopen_days": 7,
    "idle_close_days": 7,
    "signature": true,
    "ask_rating": true
}

Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.

Sending…

                    

Change the desk's settings

patch /support/settings support:configure

Changes the settings you send and leaves the rest. In hours, send only the days that change: a day left out keeps its hours, and null closes a day. A value that is not valid is refused with 422 and nothing is changed.

Request body

auto_draft

boolean

auto

string

one of off, drafts, sends

auto_reply

boolean

timezone

string

An IANA time zone name.

hours

object

The office hours per day, on the 24 hour clock in the desk's timezone: [opens, closes], or null for a closed day.

mon required

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

tue required

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

wed required

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

thu required

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

fri required

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

sat required

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

sun required

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

holidays

string, nullable

one of FR, ES, IT, BE, DK

holidays_extra

array of strings

auto_reply_text

string

at least 1 characters · at most 600 characters

staff_language

string

one of en, fr, es, it, de, nl, da

debug

boolean

reopen_days

integer

from 0 · up to 90

idle_close_days

integer

from 1 · up to 90

signature

boolean

ask_rating

boolean

Response · 200 The settings as they now stand.

object

string

auto_draft

boolean

Whether the assistant drafts when a customer writes. Off: only when you ask for a draft.

auto

string

How much the assistant does by itself. off: it drafts for a thread's messages until your desk has answered once. drafts: for every message of theirs. sends: it also sends the drafts it is highly sure of; the rest wait for a person, with needs_person set on the thread, and no automatic reply is sent.

one of off, drafts, sends

auto_reply

boolean

Answer a thread that starts while the desk is offline, once, with auto_reply_text.

timezone

string

An IANA time zone name. The office hours are in it.

hours

object

The office hours per day, on the 24 hour clock in the desk's timezone: [opens, closes], or null for a closed day.

mon

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

tue

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

wed

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

thu

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

fri

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

sat

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

sun

array of strings, nullable

When a day opens and closes, as two HH:MM times with the first before the second. Null for a closed day.

holidays

string, nullable

The country whose public holidays the desk is closed on. Null for none.

one of FR, ES, IT, BE, DK

holidays_extra

array of strings

More days the desk is closed. Returned in order, each once.

auto_reply_text

string

{next_open} becomes when the desk opens next, such as "tomorrow at 09:00".

at least 1 characters · at most 600 characters

staff_language

string

The language your people read the assistant's advice and translations in.

one of en, fr, es, it, de, nl, da

debug

boolean

Show how the assistant worked on a draft in the portal.

reopen_days

integer

A closed thread opens again when the customer writes within this many days; after that a new thread starts. 0: always a new thread.

from 0 · up to 90

idle_close_days

integer

After how many days without a message a thread that waits for the customer is closed by itself, with resolution no_response. Checked once a day; a snoozed thread is left alone until it wakes. If they write again within reopen_days, the thread opens again.

from 1 · up to 90

signature

boolean

End chat answers with the first name of the person who wrote them. Mail always is. A thread can say otherwise (signed).

ask_rating

boolean

Ask the customer whether the answer helped when a chat is closed.

Errors

401 invalid_token: the token is missing, revoked or expired.
403 insufficient_ability: the token lacks the ability this call needs.
422 validation_error: a value is not allowed, hours is missing or lacks a day, or a day closes before it opens.
429 rate_limited: too many requests. The general limit is 120 requests a minute for all your tokens of one mode (live or sandbox) together, and 300 a minute per IP address before the token is checked. Some calls have a lower limit of their own, which counts only calls that did what they ask (a call refused with another error uses up no place); the Rate limits guide lists them. Wait for the number of seconds in the Retry-After header.
curl -X PATCH https://partners.monotree.com/api/v1/support/settings \
  -H "Authorization: Bearer $MONOTREE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "auto": "drafts",
    "reopen_days": 14,
    "hours": {
        "mon": [
            "08:00",
            "17:00"
        ],
        "tue": [
            "08:00",
            "17:00"
        ],
        "wed": [
            "08:00",
            "17:00"
        ],
        "thu": [
            "08:00",
            "17:00"
        ],
        "fri": [
            "08:00",
            "16:00"
        ],
        "sat": null,
        "sun": null
    }
}'
200 · Response
{
    "object": "support_settings",
    "auto_draft": true,
    "auto": "off",
    "auto_reply": true,
    "timezone": "Europe/Paris",
    "hours": {
        "mon": [
            "09:00",
            "18:00"
        ],
        "tue": [
            "09:00",
            "18:00"
        ],
        "wed": [
            "09:00",
            "18:00"
        ],
        "thu": [
            "09:00",
            "18:00"
        ],
        "fri": [
            "09:00",
            "18:00"
        ],
        "sat": null,
        "sun": null
    },
    "holidays": "FR",
    "holidays_extra": [],
    "auto_reply_text": "Thanks for your message. We are closed right now and will answer {next_open}.",
    "staff_language": "en",
    "debug": false,
    "reopen_days": 7,
    "idle_close_days": 7,
    "signature": true,
    "ask_rating": true
}

Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.

Sending…

                    

Get whether support is online

get /support/presence support:configure

Whether your desk is there to answer right now. The office hours (less the holidays) say, unless someone forced it. While the desk is offline, a new thread gets the automatic reply (if auto_reply is on).

Response · 200 The presence.

object

string

online

boolean

forced

string, nullable

Set where someone switched it against the office hours. Null while the hours decide.

one of online, offline

forced_until

string, nullable

When the forced state ends by itself.

forced_by

string, nullable

Who switched it: a person, or API · and the name of the token.

changes_at

string, nullable

When the office hours next open or close.

Errors

401 invalid_token: the token is missing, revoked or expired.
403 insufficient_ability: the token lacks the ability this call needs.
429 rate_limited: too many requests. The general limit is 120 requests a minute for all your tokens of one mode (live or sandbox) together, and 300 a minute per IP address before the token is checked. Some calls have a lower limit of their own, which counts only calls that did what they ask (a call refused with another error uses up no place); the Rate limits guide lists them. Wait for the number of seconds in the Retry-After header.
curl https://partners.monotree.com/api/v1/support/presence \
  -H "Authorization: Bearer $MONOTREE_TOKEN"
200 · Response
{
    "object": "support_presence",
    "online": true,
    "forced": "online",
    "forced_until": "2026-11-14T13:45:37Z",
    "forced_by": "API · Back office, production",
    "changes_at": "2026-11-16T08:00:00Z"
}

Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.

Sending…

                    

Switch support online or offline

post /support/presence support:configure

true or false forces the desk online or offline whatever the office hours say; null follows the hours again. A forced state ends by itself at forced_until: online after an hour (an hour after the last answer one of your people sent in the portal), offline when support opens next. Forcing what the hours already say forces nothing and clears a forced state.

Accepts an optional Idempotency-Key header to make a retry safe.

Request body

online required

boolean, nullable

true: online. false: offline. null: follow the office hours again.
Response · 200 The presence as it now stands.

object

string

online

boolean

forced

string, nullable

Set where someone switched it against the office hours. Null while the hours decide.

one of online, offline

forced_until

string, nullable

When the forced state ends by itself.

forced_by

string, nullable

Who switched it: a person, or API · and the name of the token.

changes_at

string, nullable

When the office hours next open or close.

Errors

400 invalid_idempotency_key: the Idempotency-Key is longer than 255 characters.
401 invalid_token: the token is missing, revoked or expired.
403 insufficient_ability: the token lacks the ability this call needs.
409 idempotency_in_progress: a call with the same Idempotency-Key is still running.
422 validation_error: online is missing, or is not true, false or null. idempotency_key_reused: the Idempotency-Key was used for a different request.
429 rate_limited: too many requests. The general limit is 120 requests a minute for all your tokens of one mode (live or sandbox) together, and 300 a minute per IP address before the token is checked. Some calls have a lower limit of their own, which counts only calls that did what they ask (a call refused with another error uses up no place); the Rate limits guide lists them. Wait for the number of seconds in the Retry-After header.
curl -X POST https://partners.monotree.com/api/v1/support/presence \
  -H "Authorization: Bearer $MONOTREE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "online": true
}'
200 · Response
{
    "object": "support_presence",
    "online": true,
    "forced": "online",
    "forced_until": "2026-11-14T13:45:37Z",
    "forced_by": "API · Back office, production",
    "changes_at": "2026-11-16T08:00:00Z"
}

Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.

Sending…