> ## Documentation Index > Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt > Use this file to discover all available pages before exploring further. # Update a SIP credential > Modifies settings on an existing SIP credential — for example to enable/disable it, set call limits, configure call forwarding, or manage voicemail PIN. Username is immutable. Password is rotated separately via the /rotate endpoint. Send only the fields you wish to change; omitted fields are left untouched. Admin or owner only. ## OpenAPI ````yaml /openapi.yaml patch /api/v1/sip-credentials/{id} openapi: 3.1.0 info: title: Devotel CPaaS API description: Orbit by Devotel — Communications Platform as a Service API version: 1.0.0 contact: name: Devotel url: https://devotel.io email: support@devotel.io license: name: Proprietary servers: - url: https://api.orbit.devotel.io description: Production security: - Bearer: [] - ApiKey: [] tags: - name: Messages description: >- Send and manage messages across all channels (SMS, WhatsApp, RCS, Email, Viber, etc.) - name: Agents description: AI agent creation, configuration, and execution - name: Voice description: Voice calls, IVR, conferencing, and SIP trunking - name: Webhooks description: Webhook endpoint management and delivery logs - name: Numbers description: Phone number search, provisioning, and configuration - name: Contacts description: Contact management, segmentation, and lifecycle tracking - name: Campaigns description: Marketing campaign orchestration and analytics - name: Flows description: Automation flow builder and execution engine - name: Templates description: Message template management and approval workflows - name: Settings description: Organization, channel, and user preference settings - name: Verify description: OTP generation and verification across channels - name: Push description: Push notification delivery via FCM and APNs - name: Telegram description: >- Telegram bring-your-own-bot channel: connect a bot, verify a chat against the shared sandbox bot, and read unified channel state. Production sends go through the Messaging API. - name: USSD description: >- Menu-driven USSD for feature phones: define a menu tree, simulate session steps, and host the tenant-scoped aggregator callback. - name: Integrations description: Third-party service connections and OAuth management - name: Files description: >- Server-to-server media upload, listing, retrieval, and deletion (signed-URL backed) - name: Messaging Services description: >- Twilio MessagingService-parity containers bundling sender pool, opt-out list, inbound webhook, and sticky-sender/geomatch flags - name: Sender Pools description: >- Group sending numbers into pools with a selection strategy (sticky / round-robin / random) for outbound sends - name: Opt-Out Lists description: >- Per-list STOP / HELP / START keyword sets and auto-response copy (Twilio Advanced Opt-Out parity) - name: SMPP description: Tenant BYO-SMPP bind credentials and upstream termination carriers - name: Commerce description: >- Unified omnichannel conversational-commerce: cart/checkout state machine, cross-channel payment reconciliation, hosted pay-by-link, native WhatsApp checkout, and agentic-checkout payment mandates - name: Orby description: >- In-dashboard Orby operator assistant: streamed assistant turns, conversation threads, product knowledge-base search, and the tool-action approval gate. Available to signed-in operators only (dashboard session auth — API-key requests are rejected). paths: /api/v1/sip-credentials/{id}: patch: tags: - SIP Credentials summary: Update a SIP credential description: >- Modifies settings on an existing SIP credential — for example to enable/disable it, set call limits, configure call forwarding, or manage voicemail PIN. Username is immutable. Password is rotated separately via the /rotate endpoint. Send only the fields you wish to change; omitted fields are left untouched. Admin or owner only. parameters: - schema: type: string in: path name: id required: true - name: X-Test-Mode in: header required: false description: >- Sandbox opt-in for Clerk-session-authenticated requests. Set to `true` to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response `meta.test_mode: true`. **Ignored for live API keys (`dv_live_sk_*`)** — server-to-server clients must use a test-prefixed key (`dv_test_sk_*`) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header. schema: type: string enum: - 'true' - 'false' requestBody: required: true content: application/json: schema: type: object additionalProperties: true description: >- The fields to change — at least one is required. Omit a field to leave it untouched; send `null` on a nullable field to clear it. The on/off flags take `true` or `false` only. `username` cannot be changed (it would break every registered device) and the password is replaced through the rotate endpoint, not here. properties: label: type: string description: >- Device label, 1-32 characters. Renaming does not change the SIP username, so registered devices keep working. enabled: type: boolean description: >- Set false to refuse further registrations and inbound calls without deleting the credential; set true to re-enable it. extensionNumber: type: - string - 'null' description: >- Internal extension, 2-8 characters of digits, `*` or `#`. Send `null` to remove the extension. outboundEnabled: type: boolean description: Whether the device may place outbound calls. outboundCallerIdMode: type: string enum: - fixed - pick_from_owned - inherit_org description: >- How the From: number is chosen on outbound calls: `fixed`, `pick_from_owned` or `inherit_org`. defaultCallerIdE164: type: - string - 'null' description: >- E.164 caller ID, for example `+14155550123`. Must be a number your organization owns. Send `null` to clear it. outboundDailySpendCapCents: type: - integer - 'null' description: >- Daily outbound spend ceiling in cents (0-100000). Send `null` to remove the cap. outboundBlockedCountries: type: - array - 'null' items: type: string description: >- ISO 3166-1 alpha-2 country codes this device may not dial. Send `null` to allow every destination your organization allows. concurrentCallCap: type: - integer - 'null' description: >- Maximum simultaneous calls (1-100). Send `null` to remove the cap. expiresAt: type: - string - 'null' description: >- ISO 8601 timestamp after which the credential stops authenticating. Send `null` so it never expires. dnd: type: boolean description: >- Do-not-disturb. Inbound calls skip the device while this is true; the change applies to the next call, not just new registrations. forceCodec: type: - string - 'null' description: >- Pin media to one of `PCMU`, `PCMA`, `OPUS`, `G722` or `AMR-WB`. Send `null` to negotiate normally. forceRecordInbound: type: boolean description: Always record inbound calls to this device. forceRecordOutbound: type: boolean description: Always record outbound calls from this device. forwardBusyToUsername: type: - string - 'null' description: >- SIP username in the same organization to ring when this device is busy. Send `null` to stop forwarding. forwardNoAnswerToUsername: type: - string - 'null' description: >- SIP username in the same organization to ring when this device does not answer. Send `null` to stop forwarding. forwardUnavailableToUsername: type: - string - 'null' description: >- SIP username in the same organization to ring when this device is not registered. Send `null` to stop forwarding. allowedIpCidrs: type: - array - 'null' items: type: string description: >- Source IP allow-list in CIDR notation, up to 20 entries. Send `null` to accept registrations from any address. allowedUserAgent: type: - string - 'null' description: >- Lock the credential to one SIP User-Agent string. Send `null` to accept any client. voicemailPin: type: - string - 'null' description: >- 4-8 digit passcode for the `*97` voicemail dial-in. Send a new value to rotate it, or `null` to remove it. Stored hashed and never returned. notes: type: - string - 'null' description: >- Free-text note, up to 1000 characters. Send `null` to clear it. example: label: front-desk dnd: false concurrentCallCap: 3 forwardNoAnswerToUsername: a1b2c3d4-support allowedIpCidrs: null description: >- The fields to change — at least one is required. Omit a field to leave it untouched; send `null` on a nullable field to clear it. The on/off flags take `true` or `false` only. `username` cannot be changed (it would break every registered device) and the password is replaced through the rotate endpoint, not here. responses: '200': description: >- The updated credential object with all fields and metadata inside the standard `{ data, meta }` envelope. content: application/json: schema: type: object additionalProperties: true description: >- The updated credential object with all fields and metadata inside the standard `{ data, meta }` envelope. '400': $ref: '#/components/responses/StandardError' '401': $ref: '#/components/responses/StandardError' '403': $ref: '#/components/responses/StandardError' '404': $ref: '#/components/responses/StandardError' '422': $ref: '#/components/responses/StandardError' '429': $ref: '#/components/responses/RateLimitedResponse' '500': $ref: '#/components/responses/StandardError' components: responses: StandardError: description: >- Standard error envelope. `error.code` is machine-readable; see the [error reference](https://docs.orbit.devotel.io/reference/error-codes) for the catalogue. content: application/json: schema: type: object properties: error: type: object required: - code - message - status properties: code: type: string description: Machine-readable error code (e.g. INVALID_PHONE_NUMBER) message: type: string description: Human-readable error description status: type: integer description: HTTP status code details: type: object additionalProperties: true description: Additional context about the error meta: type: object properties: request_id: type: string timestamp: type: string format: date-time docs_url: type: string format: uri description: Link to relevant error documentation RateLimitedResponse: description: >- Rate limit exceeded. Wait `error.retry_after` seconds (or read the `Retry-After` header) before retrying. Returned when the request would exceed the bucket identified by `X-RateLimit-Bucket`. headers: X-RateLimit-Limit: description: Total request quota for the current window. schema: type: integer minimum: 0 X-RateLimit-Remaining: description: Requests remaining in the current window. schema: type: integer minimum: 0 X-RateLimit-Reset: description: >- Absolute unix-epoch-seconds timestamp at which the current window resets. schema: type: integer minimum: 0 X-RateLimit-Bucket: description: >- Name of the rate-limit bucket the request was bound by (e.g. `auth-write`, `money`, `agent-invoke`, or `custom:/`). Stripe-style — lets clients see which named cap they hit. schema: type: string RateLimit-Limit: description: >- draft-ietf-httpapi-ratelimit-headers no-prefix mirror of `X-RateLimit-Limit`. Some SDKs read only this form. schema: type: integer minimum: 0 RateLimit-Remaining: description: >- draft-ietf-httpapi-ratelimit-headers no-prefix mirror of `X-RateLimit-Remaining`. schema: type: integer minimum: 0 RateLimit-Reset: description: >- draft-ietf-httpapi-ratelimit-headers no-prefix mirror — delta seconds from now until the window resets (NOT epoch). schema: type: integer minimum: 0 Retry-After: description: >- RFC 7231 §7.1.3 — number of seconds the client should wait before retrying. schema: type: integer minimum: 1 content: application/json: schema: type: object properties: error: type: object required: - code - message - status - retry_after properties: code: type: string enum: - RATE_LIMITED description: >- Always `RATE_LIMITED` — the global request-limiter 429. Distinct from `RATE_LIMIT_EXCEEDED`, the live per-recipient/per-tenant/per-resource frequency-cap 429 (not retired). message: type: string status: type: integer enum: - 429 retry_after: type: integer minimum: 1 description: >- Seconds to wait before retrying. Mirrors `Retry-After` header. meta: type: object properties: request_id: type: string timestamp: type: string format: date-time docs_url: type: string format: uri securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT description: Dashboard JWT token from Clerk ApiKey: type: apiKey name: X-API-Key in: header description: Server-to-server API key (dv_live_sk_*) ````