Updates the given properties of a Sim resource on your Account

POST /v1/Sims/{Sid}

A resource representing a Programmable Wireless SIM

Updates the given properties of a Sim resource on your Account.

Path parameters

Sid string Required

The SID or the unique_name of the Sim resource to update.

Body

AccountSid string

The SID of the Account to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a Subaccount of the requesting Account. Only valid when the Sim resource's status is new. For more information, see the Move SIMs between Subaccounts documentation.
CallbackMethod string(http-method)

The HTTP method we should use to call callback_url. Can be: POST or GET. The default is POST.

Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
CallbackUrl string(uri)

The URL we should call using the callback_url when the SIM has finished updating. When the SIM transitions from new to ready or from any status to deactivated, we call this URL when the status changes to an intermediate status (ready or deactivated) and again when the status changes to its final status (active or canceled).
CommandsCallbackMethod string(http-method)

The HTTP method we should use to call commands_callback_url. Can be: POST or GET. The default is POST.

Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
CommandsCallbackUrl string(uri)

The URL we should call using the commands_callback_method when the SIM sends a Command. Your server should respond with an HTTP status code in the 200 range; any response body is ignored.
FriendlyName string

A descriptive string that you create to describe the Sim resource. It does not need to be unique.
RatePlan string

The SID or unique name of the RatePlan resource to which the Sim resource should be assigned.
ResetStatus string

Initiate a connectivity reset on the SIM. Set to resetting to initiate a connectivity reset on the SIM. No other value is valid.

Value is resetting.
SmsFallbackMethod string(http-method)

The HTTP method we should use to call sms_fallback_url. Can be: GET or POST. Default is POST.

Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
SmsFallbackUrl string(uri)

The URL we should call using the sms_fallback_method when an error occurs while retrieving or executing the TwiML requested from sms_url.
SmsMethod string(http-method)

The HTTP method we should use to call sms_url. Can be: GET or POST. Default is POST.

Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
SmsUrl string(uri)

The URL we should call using the sms_method when the SIM-connected device sends an SMS message that is not a Command.
Status string

The new status of the Sim resource. Can be: ready, active, suspended, or deactivated.

Values are new, ready, active, suspended, deactivated, canceled, scheduled, or updating.
UniqueName string

An application-defined string that uniquely identifies the resource. It can be used in place of the sid in the URL path to address the resource.
VoiceFallbackMethod string(http-method)

Deprecated.

Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
VoiceFallbackUrl string(uri)

Deprecated.
VoiceMethod string(http-method)

Deprecated.

Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
VoiceUrl string(uri)

Deprecated.

Responses

200

OK
Hide response attributes Show response attributes object
- account_sid string | null
  
  The SID of the Account to which the Sim resource belongs
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- commands_callback_method string(http-method) | null
  
  The HTTP method we use to call commands_callback_url
  
  Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
- commands_callback_url string(uri) | null
  
  The URL we call when the SIM originates a machine-to-machine Command
- date_created string(date-time) | null
  
  The ISO 8601 date and time in GMT when the resource was created
- date_updated string(date-time) | null
  
  The ISO 8601 date and time in GMT when the Sim resource was last updated
- e_id string | null
  
  Deprecated
- friendly_name string | null
  
  The string that you assigned to describe the Sim resource
- iccid string | null
  
  The ICCID associated with the SIM
- ip_address string | null
  
  Deprecated
- links object(uri-map) | null
  
  The URLs of related subresources
- rate_plan_sid string | null
  
  The SID of the RatePlan resource to which the Sim resource is assigned.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WP[0-9a-fA-F]{32}$.
- reset_status string | null
  
  The connectivity reset status of the SIM
  
  Value is resetting.
- sid string | null
  
  The unique string that identifies the Sim resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^DE[0-9a-fA-F]{32}$.
- sms_fallback_method string(http-method) | null
  
  Deprecated
  
  Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
- sms_fallback_url string(uri) | null
  
  Deprecated
- sms_method string(http-method) | null
  
  Deprecated
  
  Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
- sms_url string(uri) | null
  
  Deprecated
- status string | null
  
  The status of the Sim resource
  
  Values are new, ready, active, suspended, deactivated, canceled, scheduled, or updating.
- unique_name string | null
  
  An application-defined string that uniquely identifies the resource
- url string(uri) | null
  
  The absolute URL of the resource
- voice_fallback_method string(http-method) | null
  
  Deprecated. The HTTP method we use to call voice_fallback_url
  
  Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
- voice_fallback_url string(uri) | null
  
  Deprecated. The URL we call when an error occurs while retrieving or executing the TwiML requested from voice_url
- voice_method string(http-method) | null
  
  Deprecated. The HTTP method we use to call voice_url
  
  Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
- voice_url string(uri) | null
  
  Deprecated. The URL we call when the SIM-connected device makes a voice call

POST /v1/Sims/{Sid}

curl \
 -X POST https://wireless.twilio.com/v1/Sims/{Sid} \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'AccountSid=string&CallbackMethod=HEAD&CallbackUrl=https%3A%2F%2Fexample.com&CommandsCallbackMethod=HEAD&CommandsCallbackUrl=https%3A%2F%2Fexample.com&FriendlyName=string&RatePlan=string&ResetStatus=resetting&SmsFallbackMethod=HEAD&SmsFallbackUrl=https%3A%2F%2Fexample.com&SmsMethod=HEAD&SmsUrl=https%3A%2F%2Fexample.com&Status=new&UniqueName=string&VoiceFallbackMethod=HEAD&VoiceFallbackUrl=https%3A%2F%2Fexample.com&VoiceMethod=HEAD&VoiceUrl=https%3A%2F%2Fexample.com'

Request example

{
  "AccountSid": "string",
  "CallbackMethod": "HEAD",
  "CallbackUrl": "https://example.com",
  "CommandsCallbackMethod": "HEAD",
  "CommandsCallbackUrl": "https://example.com",
  "FriendlyName": "string",
  "RatePlan": "string",
  "ResetStatus": "resetting",
  "SmsFallbackMethod": "HEAD",
  "SmsFallbackUrl": "https://example.com",
  "SmsMethod": "HEAD",
  "SmsUrl": "https://example.com",
  "Status": "new",
  "UniqueName": "string",
  "VoiceFallbackMethod": "HEAD",
  "VoiceFallbackUrl": "https://example.com",
  "VoiceMethod": "HEAD",
  "VoiceUrl": "https://example.com"
}

Request examples

{
  "AccountSid": "string",
  "CallbackMethod": "HEAD",
  "CallbackUrl": "https://example.com",
  "CommandsCallbackMethod": "HEAD",
  "CommandsCallbackUrl": "https://example.com",
  "FriendlyName": "string",
  "RatePlan": "string",
  "ResetStatus": "resetting",
  "SmsFallbackMethod": "HEAD",
  "SmsFallbackUrl": "https://example.com",
  "SmsMethod": "HEAD",
  "SmsUrl": "https://example.com",
  "Status": "new",
  "UniqueName": "string",
  "VoiceFallbackMethod": "HEAD",
  "VoiceFallbackUrl": "https://example.com",
  "VoiceMethod": "HEAD",
  "VoiceUrl": "https://example.com"
}

Response examples (200)

{
  "account_sid": "string",
  "commands_callback_method": "HEAD",
  "commands_callback_url": "https://example.com",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "e_id": "string",
  "friendly_name": "string",
  "iccid": "string",
  "ip_address": "string",
  "links": {},
  "rate_plan_sid": "string",
  "reset_status": "resetting",
  "sid": "string",
  "sms_fallback_method": "HEAD",
  "sms_fallback_url": "https://example.com",
  "sms_method": "HEAD",
  "sms_url": "https://example.com",
  "status": "new",
  "unique_name": "string",
  "url": "https://example.com",
  "voice_fallback_method": "HEAD",
  "voice_fallback_url": "https://example.com",
  "voice_method": "HEAD",
  "voice_url": "https://example.com"
}

Response examples (200)

{
  "account_sid": "string",
  "commands_callback_method": "HEAD",
  "commands_callback_url": "https://example.com",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "e_id": "string",
  "friendly_name": "string",
  "iccid": "string",
  "ip_address": "string",
  "links": {},
  "rate_plan_sid": "string",
  "reset_status": "resetting",
  "sid": "string",
  "sms_fallback_method": "HEAD",
  "sms_fallback_url": "https://example.com",
  "sms_method": "HEAD",
  "sms_url": "https://example.com",
  "status": "new",
  "unique_name": "string",
  "url": "https://example.com",
  "voice_fallback_method": "HEAD",
  "voice_fallback_url": "https://example.com",
  "voice_method": "HEAD",
  "voice_url": "https://example.com"
}