Update short code
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.
Authentication
AuthorizationBasic
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)
```
Path parameters
id
Unique ID of the short code.
Request
This endpoint expects an object.
name
The name given to the short code.
message_handler
The message handler type for incoming messages.
Allowed values:
message_request_url
The URL to send message requests to when using laml_webhooks handler.
message_request_method
The HTTP method to use for message requests. Defaults to POST.
Allowed values:
message_fallback_url
The fallback URL for message requests.
message_fallback_method
The HTTP method to use for fallback requests. Defaults to POST.
Allowed values:
message_laml_application_id
The ID of the LāML application to handle messages when using laml_application handler.
message_relay_context
The Relay context to use when using relay_context handler.
Response
The request has succeeded.
id
The unique identifier of the short code.
name
The name given to the short code.
number
The short code number.
capabilities
The messaging capabilities of the short code.
Allowed values:
number_type
The type of number (always ‘shortcode’).
Allowed values:
code_type
The type of short code.
Allowed values:
country_code
The ISO 3166-1 alpha-2 country code.
created_at
The date and time when the short code was created.
updated_at
The date and time when the short code was last updated.
next_billed_at
The date and time when the short code will next be billed.
lease_duration
The lease duration of the short code (e.g., ‘12 months’).
message_handler
The message handler type for incoming messages.
Allowed values:
message_request_url
The URL to send message requests to when using laml_webhooks handler.
message_request_method
The HTTP method to use for message requests.
Allowed values:
message_fallback_url
The fallback URL for message requests.
message_fallback_method
The HTTP method to use for fallback requests.
Allowed values:
message_laml_application_id
The ID of the LāML application to handle messages when using laml_application handler.
message_relay_context
The Relay context to use when using relay_context handler.
Errors
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
