Update Short URL
Description
To update a Short URL, it is necessary to make a PUT request to the SHORT URL API endpoint with the "masked_url_id"
The version_datestamp needs to be same as the "time_last_updated" which is available in the retrieve details API response
Production Endpoint URL: https://api.cpaas.symphony.rakuten.net/short-url/v1/url/$masked_url_id
Methods: PUT
HTTP Headers
| Parameter | Required | Value |
|---|---|---|
| Authentication | Y | Type: Bearer Token: JWT Token |
| Accept | Y | application/json |
| Content-Type | Y | application/json; charset=UTF-8 |
Request Body Schema: application/json
| Parameter | Required | Description |
|---|---|---|
| version_datestamp | Y | Time Last Updated as reflected in the Short URL Details |
| masked_url | Y | The details to be updated, at least one field should be updated |
| ┗name | Optional | Updated name |
| ┗description | Optional | Updated short description for the Short URL |
| ┗valid_until_date | Optional | Valid until date in the format "yyyy-MM-dd HH:mm:ss" e.g.., "2024-06-15 13:21:45"" Default: 3 days Minimum: 5 mins Maximum: 30 days |
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"
}
}
Response:
If successful, the API call will return an HTTP 200 OK with a JSON document as a response. Please see section “Error Codes" for a description of the failure responses.