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

# update

> Update a short code's configuration.

Update a short code's configuration. Uses PUT.

### Schema

```yaml
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
paths:
  /api/relay/rest/short_codes/{id}:
    put:
      operationId: update_short_code
      summary: Update short code
      description: >-
        Updates a short code's configuration.


        #### Permissions


        The API token used to authenticate must have the following scope(s)
        enabled to make a successful request: _Numbers_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_shortCodes
      parameters:
        - name: id
          in: path
          description: Unique ID of the short code.
          required: true
          schema:
            $ref: '#/components/schemas/uuid'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShortCodeResponse'
        '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 failed validation. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.ValidationError'
        '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/UpdateShortCodeRequest'
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
    ShortCodeMessageHandler:
      type: string
      enum:
        - relay_context
        - laml_webhooks
        - laml_application
      description: Message handler type for short codes.
      title: ShortCodeMessageHandler
    HttpMethod:
      type: string
      enum:
        - GET
        - POST
      description: HTTP method type.
      title: HttpMethod
    UpdateShortCodeRequest:
      type: object
      properties:
        name:
          type: string
          description: The name given to the short code.
        message_handler:
          $ref: '#/components/schemas/ShortCodeMessageHandler'
          description: The message handler type for incoming messages.
        message_request_url:
          type: string
          description: >-
            The URL to send message requests to when using laml_webhooks
            handler.
        message_request_method:
          $ref: '#/components/schemas/HttpMethod'
          default: POST
          description: The HTTP method to use for message requests. Defaults to POST.
        message_fallback_url:
          type: string
          description: The fallback URL for message requests.
        message_fallback_method:
          $ref: '#/components/schemas/HttpMethod'
          default: POST
          description: The HTTP method to use for fallback requests. Defaults to POST.
        message_laml_application_id:
          $ref: '#/components/schemas/uuid'
          description: >-
            The ID of the LāML application to handle messages when using
            laml_application handler.
        message_relay_context:
          type: string
          description: The Relay context to use when using relay_context handler.
      required:
        - name
        - message_handler
      description: Request body for updating a short code.
      title: UpdateShortCodeRequest
    ShortCodeCapability:
      type: string
      enum:
        - sms
        - mms
      description: Short code capabilities.
      title: ShortCodeCapability
    ShortCodeResponseNumberType:
      type: string
      enum:
        - shortcode
      description: The type of number (always 'shortcode').
      title: ShortCodeResponseNumberType
    ShortCodeType:
      type: string
      enum:
        - vanity
        - random
      description: Short code type.
      title: ShortCodeType
    ShortCodeResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: The unique identifier of the short code.
        name:
          type:
            - string
            - 'null'
          description: The name given to the short code.
        number:
          type: string
          description: The short code number.
        capabilities:
          type: array
          items:
            $ref: '#/components/schemas/ShortCodeCapability'
          description: The messaging capabilities of the short code.
        number_type:
          $ref: '#/components/schemas/ShortCodeResponseNumberType'
          description: The type of number (always 'shortcode').
        code_type:
          $ref: '#/components/schemas/ShortCodeType'
          description: The type of short code.
        country_code:
          type: string
          description: The ISO 3166-1 alpha-2 country code.
        created_at:
          type: string
          description: The date and time when the short code was created.
        updated_at:
          type: string
          description: The date and time when the short code was last updated.
        next_billed_at:
          type:
            - string
            - 'null'
          description: The date and time when the short code will next be billed.
        lease_duration:
          type:
            - string
            - 'null'
          description: The lease duration of the short code (e.g., '12 months').
        message_handler:
          oneOf:
            - $ref: '#/components/schemas/ShortCodeMessageHandler'
            - type: 'null'
          description: The message handler type for incoming messages.
        message_request_url:
          type:
            - string
            - 'null'
          description: >-
            The URL to send message requests to when using laml_webhooks
            handler.
        message_request_method:
          oneOf:
            - $ref: '#/components/schemas/HttpMethod'
            - type: 'null'
          description: The HTTP method to use for message requests.
        message_fallback_url:
          type:
            - string
            - 'null'
          description: The fallback URL for message requests.
        message_fallback_method:
          oneOf:
            - $ref: '#/components/schemas/HttpMethod'
            - type: 'null'
          description: The HTTP method to use for fallback requests.
        message_laml_application_id:
          oneOf:
            - $ref: '#/components/schemas/uuid'
            - type: 'null'
          description: >-
            The ID of the LāML application to handle messages when using
            laml_application handler.
        message_relay_context:
          type:
            - string
            - 'null'
          description: The Relay context to use when using relay_context handler.
      required:
        - id
        - name
        - number
        - capabilities
        - number_type
        - code_type
        - country_code
        - created_at
        - updated_at
        - next_billed_at
        - lease_duration
        - message_handler
        - message_request_url
        - message_request_method
        - message_fallback_url
        - message_fallback_method
        - message_laml_application_id
        - message_relay_context
      description: Response containing a single short code.
      title: ShortCodeResponse
    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.SpaceApiErrorItem:
      type: object
      properties:
        detail:
          type: string
          description: A description of what caused the error.
        status:
          type: string
          description: The HTTP status code.
        title:
          type: string
          description: A short summary of the error type.
        code:
          type: string
          description: The error code.
      required:
        - detail
        - status
        - title
        - code
      description: Details about a specific validation error.
      title: Types.StatusCodes.SpaceApiErrorItem
    Types.StatusCodes.ValidationError:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.SpaceApiErrorItem'
          description: List of validation errors.
      required:
        - errors
      description: The request failed validation. See errors for details.
      title: Types.StatusCodes.ValidationError
    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": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "My Short Code",
  "number": "12345",
  "capabilities": [
    "sms"
  ],
  "number_type": "shortcode",
  "code_type": "vanity",
  "country_code": "US",
  "created_at": "2023-01-15T10:30:00Z",
  "updated_at": "2023-01-15T10:30:00Z",
  "next_billed_at": "2024-01-15T10:30:00Z",
  "lease_duration": "12 months",
  "message_handler": "relay_context",
  "message_request_url": "https://example.com/message",
  "message_request_method": "GET",
  "message_fallback_url": "https://example.com/fallback",
  "message_fallback_method": "GET",
  "message_laml_application_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "message_relay_context": "my-context"
}
```

## **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"
});

await client.shortCodes.update("short-code-id", {
    message_request_url: "https://example.com/sms",
});
```