短縮URLを更新
詳細
短縮URLを更新するためには、”masked_url_id” ともにPUTメソッドで” SHORT URL”エンドポイントにリクエストする必要があります。
version_datestampは、短縮URLの詳細を取得する際のAPIのレスポンスに含まれる”time_last_updated”と同じである必要があります。
エンドポイントURL: https://api.cpaas.symphony.rakuten.net/short-url/v1/url/$masked_url_id
メソッド: PUT
HTTP ヘッダー
パラメーター | 要否 | 値 |
---|---|---|
Authentication | 必須 | Type: Bearer Token: JWT Token |
Accept | 必須 | application/json |
Content-Type | 必須 | application/json; charset=UTF-8 |
リクエストボディスキーマ: application/json
パラメーター | 要否 | 詳細/値 |
---|---|---|
version_datestamp | 必須 | 短縮URLの詳細に反映される最終更新時刻 |
masked_url | 必須 | 更新する詳細情報、少なくとも1つのフィールドを更新する必要があります。 |
┗name | 任意 | 更新された名前 |
┗description | 任意 | 短縮URLの更新された概要 |
┗valid_until_date | 任意 | 有効期限の日付形式はyyyy-MM-dd HH:mm:ss 例:"2024-06-15 13:21:45" デフォルト: 3日間 最小: 5分 最大: 30日間 |
Sample Request
{
"version_datestamp" : "2024-05-27 05:48:21",
"masked_url": {
"name": "OSSI",
"description": "OSSI",
"valid_until_date": "2024-05-30 18:00:00"
}
}
サンプルレスポンス
成功した場合、APIコールはHTTP 200 OKとJSONドキュメントをレスポンスとして返します。失敗した場合のレスポンスについては、「エラーコード」セクションを参照してください。