Presence
Report who is online in your app
Use it from your backend to tell Lelemon which of your users are in your app, so the team sees them as online or as last seen. Send up to 100 signals per call, identified by the externalRef of the contact: state active about every 60 seconds while the person is in your app, and offline when they leave. A contact is online while its last active signal is less than 120 seconds old. It answers 202 with only how many signals matched a contact of this organization, never which ones, and it does not create contacts: create them first with PUT /v2/contacts/by-external-ref/{externalRef}. It stores only the last signal of each contact, no history, and sends no webhook. Presence shows in contacts and cases once the organization setting presenceEnabled is on. Sending the same signal twice is harmless.
Required scope: contacts:presence.
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Idempotency-KeyMakes the request safe to retry. Once it starts running, its final response (2xx, 4xx or 5xx) is kept for 24 hours and the same key gets it back, without repeating the effect. A request rejected before it runs leaves the key free. A replayed create omits the secret. The same key with a different request is rejected with 409 idempotency_key_reused.
Report who is online in your app › Request Body
Report who is online in your app › Responses
objectacceptedHow many signals matched a contact of this organization. It does not say which ones did not.
Read the presence setting
Use it to know why presence does not show: it needs enabled true and hasSignals true. It reads the organization or subaccount the key acts on.
Required scope: presence:configure.
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Read the presence setting › Responses
objectenabledThe organization setting presenceEnabled. Presence shows only when it is true and hasSignals is true.
hasSignalsTrue once at least one signal arrived through POST /v2/presence-signals.
Turn presence on or off
Sets the organization setting presenceEnabled for the organization or subaccount the key acts on. Turn it on before reading presence or filtering contacts and cases with presence=online, which answer 409 presence_not_configured while it is off. Turning it off hides presence but keeps the stored signals. Idempotent: the same body leaves the same setting.
Required scope: presence:configure.
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Turn presence on or off › Request Body
enabledtrue shows online and last seen in contacts and cases and allows presence=online. false hides them. Signals keep being stored while it is off.
Turn presence on or off › Responses
objectenabledThe organization setting presenceEnabled. Presence shows only when it is true and hasSignals is true.
hasSignalsTrue once at least one signal arrived through POST /v2/presence-signals.