Skip to main content
PATCH
Enable or disable an agent’s existing SIP registration by flipping a single flag. Unlike Set SIP Registration, this endpoint does not require you to resend sipDomain, username, password, or any other field — all stored settings are preserved. Use it to register or deregister an agent while keeping its SIP credentials on file.
This endpoint moves the registration flag only — the agent’s status field is left as it is, so an agent deregistered this way still reads as active. To move both together, use Update Agent Status.
The agent must already have a SIP registration configured. If none exists, this endpoint returns 404. Use Set SIP Registration to create the configuration first, or Delete SIP Registration to remove it entirely.

Path Parameters

string
required
The unique identifier of the agent (UUID format)

Request Body

boolean
required
Set to true to enable (register) the agent, or false to disable it.This is the only accepted field — any additional properties are rejected with a 400 error. All other SIP settings are left untouched.

How It Works

  1. API validates that registrationEnabled is a boolean
  2. Loads the existing sip_registration_data for the agent (returns 404 if none is configured)
  3. Updates only the registrationEnabled flag, preserving every other stored field
  4. Sync service picks up the change via Supabase realtime and registers or deregisters with OpenSIPS accordingly
Disabling a registration keeps the SIP configuration stored, so you can re-enable it later with a single PATCH — no need to re-enter credentials. To remove the configuration completely, use the Delete SIP Registration endpoint.

Troubleshooting