> For a complete index of all SignalWire documentation pages, fetch https://signalwire.com/docs/llms.txt

# update

> Partially update a SIP gateway resource.

Partially update a SIP gateway resource. Uses PATCH for partial.

### Schema

```yaml
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
paths:
  /api/fabric/resources/sip_gateways/{id}:
    patch:
      operationId: update_sip_gateway
      summary: Update SIP gateway
      description: >-
        Updates a SIP Gateway by ID


        #### Permissions


        The API token used to authenticate must have the following scope(s)
        enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or
        _Video_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_sipGateway
      parameters:
        - name: id
          in: path
          description: Unique ID of a SIP Gateway.
          required: true
          schema:
            $ref: '#/components/schemas/uuid'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipGatewayResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '422':
          description: The request contains invalid parameters. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipGatewayCreateStatusCode422'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SipGatewayRequestUpdate'
servers:
  - url: https://%7BYour_Space_Name%7D.signalwire.com
    description: SignalWire API
components:
  schemas:
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    Encryption:
      type: string
      enum:
        - required
        - optional
        - default
      title: Encryption
    Ciphers:
      type: string
      enum:
        - AEAD_AES_256_GCM_8
        - AES_256_CM_HMAC_SHA1_80
        - AES_CM_128_HMAC_SHA1_80
        - AES_256_CM_HMAC_SHA1_32
        - AES_CM_128_HMAC_SHA1_32
      title: Ciphers
    Codecs:
      type: string
      enum:
        - PCMU
        - PCMA
        - G722
        - G729
        - OPUS
        - OPUS@48000H@20I
        - OPUS@24000H@20I
        - OPUS@16000H@20I
        - OPUS@8000H@20I
        - VP8
        - H264
      title: Codecs
    SipGatewayRequestUpdate:
      type: object
      properties:
        name:
          type: string
          description: Display name for the SIP Gateway.
        uri:
          type: string
          description: External SIP URI.
        encryption:
          $ref: '#/components/schemas/Encryption'
          description: Specifies the encryption requirement for the SIP connection.
        ciphers:
          type: array
          items:
            $ref: '#/components/schemas/Ciphers'
          description: List of supported SIP ciphers.
        codecs:
          type: array
          items:
            $ref: '#/components/schemas/Codecs'
          description: List of supported codecs for media transmission.
      title: SipGatewayRequestUpdate
    SipGatewayResponseType:
      type: string
      enum:
        - sip_gateway
      description: Type of the resource.
      title: SipGatewayResponseType
    SipGateway:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the SIP Gateway.
        uri:
          type: string
          description: The URI for the SIP Gateway.
        name:
          type: string
          description: Display name of the SIP Gateway.
        ciphers:
          type: array
          items:
            $ref: '#/components/schemas/Ciphers'
          description: List of supported SIP ciphers.
        codecs:
          type: array
          items:
            $ref: '#/components/schemas/Codecs'
          description: List of supported codecs.
        encryption:
          $ref: '#/components/schemas/Encryption'
          description: Specifies the encryption requirement.
      required:
        - id
        - uri
        - name
        - ciphers
        - codecs
        - encryption
      title: SipGateway
    SipGatewayResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the resource.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Project ID associated with the resource.
        display_name:
          type: string
          description: Display name of the SIP Gateway.
        type:
          $ref: '#/components/schemas/SipGatewayResponseType'
          description: Type of the resource.
        created_at:
          type: string
          format: date-time
          description: Timestamp when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the resource was last updated.
        sip_gateway:
          $ref: '#/components/schemas/SipGateway'
          description: SIP Gateway configuration details.
      required:
        - id
        - project_id
        - display_name
        - type
        - created_at
        - updated_at
        - sip_gateway
      title: SipGatewayResponse
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    TypesStatusCodesStatusCode404Error:
      type: string
      enum:
        - Not Found
      title: TypesStatusCodesStatusCode404Error
    Types.StatusCodes.StatusCode404:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode404Error'
      required:
        - error
      description: The server cannot find the requested resource.
      title: Types.StatusCodes.StatusCode404
    Types.StatusCodes.RestApiErrorItem:
      type: object
      properties:
        type:
          type: string
          description: The category of error.
        code:
          type: string
          description: A specific error code.
        message:
          type: string
          description: A description of what caused the error.
        attribute:
          type:
            - string
            - 'null'
          description: The request parameter that caused the error, if applicable.
        url:
          type: string
          description: A link to documentation about this error.
      required:
        - type
        - code
        - message
        - url
      description: Details about a specific error.
      title: Types.StatusCodes.RestApiErrorItem
    SipGatewayCreateStatusCode422:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.RestApiErrorItem'
          description: List of validation errors.
      required:
        - errors
      description: The request contains invalid parameters. See errors for details.
      title: SipGatewayCreateStatusCode422
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500

```

## **Response Example**

### Response (200)

```json
{
  "id": "0823a606-0aff-4c90-9eba-f88ba118fe05",
  "project_id": "bc949800-7b40-43cf-8438-a85facfcbdd1",
  "display_name": "My SIP Gateway",
  "type": "sip_gateway",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "sip_gateway": {
    "id": "cce59cad-104d-4c28-ada4-98cfd102ae09",
    "uri": "user3@domain.com",
    "name": "My SIP Gateway",
    "ciphers": [
      "AEAD_AES_256_GCM_8"
    ],
    "codecs": [
      "OPUS"
    ],
    "encryption": "required"
  }
}
```

## **Example**

```typescript {9}
import { RestClient } from "@signalwire/sdk";

const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com",
});

const updated = await client.fabric.sipGateways.update("gateway-id", {
  name: "updated-name",
});
console.log("Updated:", updated.display_name);
```