# Update SIP Endpoint

PUT https://%7BYour_Space_Name%7D.signalwire.com/api/fabric/resources/sip_endpoints/{id}
Content-Type: application/json

Updates a SIP Endpoint 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).

Reference: https://signalwire.com/docs/apis/fabric/sip-endpoints/update-sip-endpoint

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: fabric
  version: 1.0.0
paths:
  /resources/sip_endpoints/{id}:
    put:
      operationId: update-sip-endpoint
      summary: Update SIP Endpoint
      description: >-
        Updates a SIP Endpoint 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_sipEndpoints
      parameters:
        - name: id
          in: path
          description: Unique ID of a SIP Endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/uuid'
        - name: Authorization
          in: header
          description: >-
            SignalWire Basic Authentication using Project ID and API Token.


            The client sends HTTP requests with the Authorization header
            containing

            the word Basic followed by a space and a base64-encoded string of
            project_id:token.

            The project ID will be used as the username and the API token as the
            password.


            Example:

            ```

            Authorization: Basic base64(project_id:token)

            ```
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipEndpointResponse'
        '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/ResourceSipEndpointUpdateStatusCode422'
        '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/SipEndpointUpdateRequest'
servers:
  - url: https://%7BYour_Space_Name%7D.signalwire.com/api/fabric
components:
  schemas:
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    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
        - VP8
        - H264
      title: Codecs
    Encryption:
      type: string
      enum:
        - required
        - optional
        - default
      title: Encryption
    CallHandlerType:
      type: string
      enum:
        - default
        - passthrough
        - block-pstn
        - resource
      title: CallHandlerType
    SipEndpointUpdateRequest:
      type: object
      properties:
        username:
          type: string
          description: The username of the Sip Endpoint
        caller_id:
          type: string
          description: The caller ID that will showup when dialing from this Sip Endpoint
        send_as:
          type: string
          description: >-
            The Sip username that will show up on the calle's side. Overrides
            the username.
        ciphers:
          type: array
          items:
            $ref: '#/components/schemas/Ciphers'
          description: Ciphers that can be enabled for calls on this Sip Endpoint.
        codecs:
          type: array
          items:
            $ref: '#/components/schemas/Codecs'
          description: Codecs that can be enabled for calls on this Sip Endpoint.
        encryption:
          $ref: '#/components/schemas/Encryption'
          description: The set encryption type on the Sip Endpoint.
        call_handler:
          $ref: '#/components/schemas/CallHandlerType'
          description: >-
            Specify how the SIP endpoint will handle outbound calls.

            - **default**: The SIP endpoint will pull the outbound policy
            setting from the [SIP Profile
            Settings](https://my.signalwire.com?page=sip_profile/edit). This
            allows centralized management of outbound call behavior across
            multiple endpoints from a single configuration.

            - **passthrough**: The SIP endpoint will be allowed to dial PSTN
            numbers. This permits outbound calling to traditional phone numbers
            without restrictions.

            - **block-pstn**: The SIP endpoint will be blocked from dialing PSTN
            numbers. Use this to restrict the endpoint from initiating calls to
            the public telephone network.

            - **resource**: Outbound calls from this SIP endpoint will dial the
            specified resource and execute its instructions. Requires setting
            `calling_handler_resource_id` to a valid resource. This enables
            custom call handling workflows for outbound calls.
        calling_handler_resource_id:
          oneOf:
            - $ref: '#/components/schemas/uuid'
            - type: 'null'
          description: >-
            If `call_handler` is set to `resource`, this field will contain the
            id of the set resouce. Will be `null` otherwise.
      required:
        - calling_handler_resource_id
      title: SipEndpointUpdateRequest
    SipEndpointResponseType:
      type: string
      enum:
        - sip_endpoint
      description: Type of the Fabric Resource
      title: SipEndpointResponseType
    SipEndpoint:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: The id of the Sip Endpoint
        username:
          type: string
          description: The username of the Sip Endpoint
        caller_id:
          type: string
          description: The caller ID that will showup when dialing from this Sip Endpoint
        send_as:
          type: string
          description: >-
            The Sip username that will show up on the calle's side. Overrides
            the username.
        ciphers:
          type: array
          items:
            $ref: '#/components/schemas/Ciphers'
          description: Ciphers that can be enabled for calls on this Sip Endpoint.
        codecs:
          type: array
          items:
            $ref: '#/components/schemas/Codecs'
          description: Codecs that can be enabled for calls on this Sip Endpoint.
        encryption:
          $ref: '#/components/schemas/Encryption'
          description: The set encryption type on the Sip Endpoint.
        call_handler:
          $ref: '#/components/schemas/CallHandlerType'
          description: >-
            Specify how the SIP endpoint will handle outbound calls.

            - **default**: The SIP endpoint will pull the outbound policy
            setting from the [SIP Profile
            Settings](https://my.signalwire.com?page=sip_profile/edit). This
            allows centralized management of outbound call behavior across
            multiple endpoints from a single configuration.

            - **passthrough**: The SIP endpoint will be allowed to dial PSTN
            numbers. This permits outbound calling to traditional phone numbers
            without restrictions.

            - **block-pstn**: The SIP endpoint will be blocked from dialing PSTN
            numbers. Use this to restrict the endpoint from initiating calls to
            the public telephone network.

            - **resource**: Outbound calls from this SIP endpoint will dial the
            specified resource and execute its instructions. Requires setting
            `calling_handler_resource_id` to a valid resource. This enables
            custom call handling workflows for outbound calls.
        calling_handler_resource_id:
          oneOf:
            - $ref: '#/components/schemas/uuid'
            - type: 'null'
          description: >-
            If `call_handler` is set to `resource`, this field expects the id of
            the set resouce. Will be `null` otherwise.
      required:
        - id
        - username
        - caller_id
        - send_as
        - ciphers
        - codecs
        - encryption
        - call_handler
        - calling_handler_resource_id
      title: SipEndpoint
    SipEndpointResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the SIP Endpoint.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the SIP Endpoint Fabric Resource
        type:
          $ref: '#/components/schemas/SipEndpointResponseType'
          description: Type of the Fabric Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        sip_endpoint:
          $ref: '#/components/schemas/SipEndpoint'
          description: SIP Endpoint data.
      required:
        - id
        - project_id
        - display_name
        - type
        - created_at
        - updated_at
        - sip_endpoint
      title: SipEndpointResponse
    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
    ResourceSipEndpointUpdateStatusCode422:
      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: ResourceSipEndpointUpdateStatusCode422
    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
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: basic
      description: >-
        SignalWire Basic Authentication using Project ID and API Token.


        The client sends HTTP requests with the Authorization header containing

        the word Basic followed by a space and a base64-encoded string of
        project_id:token.

        The project ID will be used as the username and the API token as the
        password.


        Example:

        ```

        Authorization: Basic base64(project_id:token)

        ```

```

## SDK Code Examples

```python
import requests

url = "https://{your_space_name}.signalwire.com/api/fabric/resources/sip_endpoints/id"

payload = { "calling_handler_resource_id": "993ed018-9e79-4e50-b97b-984bd5534095" }
headers = {
    "Authorization": "Basic <project_id>:<api_token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://{your_space_name}.signalwire.com/api/fabric/resources/sip_endpoints/id';
const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Basic <project_id>:<api_token>',
    'Content-Type': 'application/json'
  },
  body: '{"calling_handler_resource_id":"993ed018-9e79-4e50-b97b-984bd5534095"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{your_space_name}.signalwire.com/api/fabric/resources/sip_endpoints/id"

	payload := strings.NewReader("{\n  \"calling_handler_resource_id\": \"993ed018-9e79-4e50-b97b-984bd5534095\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Basic <project_id>:<api_token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://{your_space_name}.signalwire.com/api/fabric/resources/sip_endpoints/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <project_id>:<api_token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"calling_handler_resource_id\": \"993ed018-9e79-4e50-b97b-984bd5534095\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://{your_space_name}.signalwire.com/api/fabric/resources/sip_endpoints/id")
  .header("Authorization", "Basic <project_id>:<api_token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"calling_handler_resource_id\": \"993ed018-9e79-4e50-b97b-984bd5534095\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://{your_space_name}.signalwire.com/api/fabric/resources/sip_endpoints/id', [
  'body' => '{
  "calling_handler_resource_id": "993ed018-9e79-4e50-b97b-984bd5534095"
}',
  'headers' => [
    'Authorization' => 'Basic <project_id>:<api_token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://{your_space_name}.signalwire.com/api/fabric/resources/sip_endpoints/id");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Basic <project_id>:<api_token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"calling_handler_resource_id\": \"993ed018-9e79-4e50-b97b-984bd5534095\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Basic <project_id>:<api_token>",
  "Content-Type": "application/json"
]
let parameters = ["calling_handler_resource_id": "993ed018-9e79-4e50-b97b-984bd5534095"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/fabric/resources/sip_endpoints/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```