SIsinch
SMS Apps

Update an sms app

Changed on

Updates the name of an existing sms app.

patch/v1/projects/{projectId}/sms/smsApps/{smsAppId}

Request

  • Base URL
    https://provisioning.api.sinch.com
  • URL
    https://provisioning.api.sinch.com/v1/projects/{projectId}/sms/smsApps/{smsAppId}
  • Auth
    HTTP basic and HTTP bearer and OAuth 2
    Client credentials
    Token URL: https://auth.sinch.com/oauth2/token

Path parameters

projectIdstring required

The unique ID of the project. You can find this on the <a href="https://dashboard.sinch.com/">Sinch Dashboard</a>.

smsAppIdstring required

Request body

namestring

New name for the SMS App.

Response

Updated sms app

idstring required

SMS App id.

smsServiceIdstring required

Id of the SMS Service which the SMS App belongs to.

namestring required

Name of SMS App.

status'ACTIVE' | 'BLOCKED' | 'DELETED' | 'DEPROVISIONING' | 'DEPROVISIONING_FAILED' | 'FAILED_ADD' | 'FAILED_BLOCK' | 'FAILED_DELETE' | 'FAILED_UNBLOCK' | 'FAILED_UPDATE' | 'IN_PROGRESS_ADD' | 'IN_PROGRESS_BLOCK' | 'IN_PROGRESS_DELETE' | 'IN_PROGRESS_UNBLOCK' | 'IN_PROGRESS_UPDATE' | 'PENDING_ADD' | 'PENDING_BLOCK' | 'PENDING_DELETE' | 'PENDING_UNBLOCK' | 'PENDING_UPDATE' | 'PROVISIONING' | 'PROVISIONING_ADD' | 'PROVISIONING_ADD_FAILED' | 'PROVISIONING_BLOCK' | 'PROVISIONING_BLOCK_FAILED' | 'PROVISIONING_FAILED' | 'PROVISIONING_UNBLOCK' | 'PROVISIONING_UNBLOCK_FAILED' | 'PROVISIONING_UPDATE' | 'PROVISIONING_UPDATE_FAILED' | 'STATUS_UNSPECIFIED' | 'UNRECOGNIZED' required

Status of SMS App.

regionsSmsSmsAppRegionsEnum[] required

List of regions of the app.

testboolean required

True if the app is a test app.

Changes

  • c6a937922d10Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the ///// response's property type changed from string to no type for status

    • breaking

      the ///// response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • info

      removed subschema #1: InvalidInputErrorTitle subschema #2: NoFieldsToUpdateErrorTitle from the response body oneOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added to the ///// response property allOf list for the response status

    • info

      added to the ///// response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      removed the ACTIVE enum value from the ///// response property for the response status

    • info

      removed the ACTIVE enum value from the response property for the response status

    • info

      removed the BLOCKED enum value from the response property for the response status

    • info

      removed the BR enum value from the ///// response property for the response status

    • info

      removed the DELETED enum value from the response property for the response status

    • info

      removed the DEPROVISIONING enum value from the response property for the response status

    • info

      removed the DEPROVISIONING_FAILED enum value from the response property for the response status

    • info

      removed the EU enum value from the ///// response property for the response status

    • info

      removed the FAILED_ADD enum value from the response property for the response status

    • info

      removed the FAILED_BLOCK enum value from the response property for the response status

    • info

      removed the FAILED_DELETE enum value from the response property for the response status

    • info

      removed the FAILED_UNBLOCK enum value from the response property for the response status

    • info

      removed the FAILED_UPDATE enum value from the response property for the response status

    • info

      removed the FAILING enum value from the ///// response property for the response status

    • info

      removed the IN_PROGRESS_ADD enum value from the response property for the response status

    • info

      removed the IN_PROGRESS_BLOCK enum value from the response property for the response status

    • info

      removed the IN_PROGRESS_DELETE enum value from the response property for the response status

    • info

      removed the IN_PROGRESS_UNBLOCK enum value from the response property for the response status

    • info

      removed the IN_PROGRESS_UPDATE enum value from the response property for the response status

    • info

      removed the PENDING enum value from the ///// response property for the response status

    • info

      removed the PENDING_ADD enum value from the response property for the response status

    • info

      removed the PENDING_BLOCK enum value from the response property for the response status

    • info

      removed the PENDING_DELETE enum value from the response property for the response status

    • info

      removed the PENDING_UNBLOCK enum value from the response property for the response status

    • info

      removed the PENDING_UPDATE enum value from the response property for the response status

    • info

      removed the PROVISIONING enum value from the response property for the response status

    • info

      removed the PROVISIONING_ADD enum value from the response property for the response status

    • info

      removed the PROVISIONING_ADD_FAILED enum value from the response property for the response status

    • info

      removed the PROVISIONING_BLOCK enum value from the response property for the response status

    • info

      removed the PROVISIONING_BLOCK_FAILED enum value from the response property for the response status

    • info

      removed the PROVISIONING_FAILED enum value from the response property for the response status

    • info

      removed the PROVISIONING_UNBLOCK enum value from the response property for the response status

    • info

      removed the PROVISIONING_UNBLOCK_FAILED enum value from the response property for the response status

    • info

      removed the PROVISIONING_UPDATE enum value from the response property for the response status

    • info

      removed the PROVISIONING_UPDATE_FAILED enum value from the response property for the response status

    • info

      removed the STATUS_UNSPECIFIED enum value from the response property for the response status

    • info

      removed the UNRECOGNIZED enum value from the ///// response property for the response status

    • info

      removed the UNRECOGNIZED enum value from the ///// response property for the response status

    • info

      removed the UNRECOGNIZED enum value from the response property for the response status

    • info

      removed the US enum value from the ///// response property for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • c78a716de420Revision changes
    • info

      api operation id SmsAppsController_updateSmsApp_v1 removed and replaced with SmsSmsAppsController_updateSmsApp_v1