Skip to content

Update URL

Pricing Tier Licence Type

Update URL API allows the user to suggest a URL edit of a specific network for a POI.

Warning

This API does not instantly update a URL.
The submitted URL will be subject to an asynchronous analysis and possibly approved.
If approved, it will eventually appear in List URLs response.

Request

Endpoint

PUT /v4/{billing_plan}/account/{account_id}/management/poi/{poi_id}/url/{url_id}

Path Parameters

Name                       Description Type Examples
*{billing_plan} Billing plan to be applied to the call. string licence
ondemand
*{account_id} Provided identifier of the account. string
*{poi_id} Identifier of the POI to delete the URL for.
Value obtainable either :
- if {billing_plan}licence, from $.results[*].resource.id field of List Licences Response Body
- if {billing_plan}ondemand, from $.results.pois[*].id field of any Search API Response Body.
string XXeUNbmtYZTsH7UGvNfXWo
*{url_id} Identifier of the URL to delete.
Value obtainable from $.urls[*].id field of List URLs Response Body.
string 3152963

Header Parameters

Name                          Description Type Examples                         
*x-api-key Provided API key {x_api_key} that allows authentication. string
*Authorization Provided token {jwt_bearer} that allows authorization. string Bearer {jwt_bearer}

Body

URL

Field Description Type Examples
*network Identifier of the network. string booking
facebook
*url URL of the POI in the relative network. string http://www.booking.com/hotel/it/astoria-palace.it.html
https://www.facebook.com/astoriapalacehotel
Example
curl -X PUT 'https://api.datappeal.io/v4/account/{account_id}/management/poi/XXeUNbmtYZTsH7UGvNfXWo/url/3152963' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \
-H 'Content-Type: application/json' \
-d '{
"network": "booking",
"url": "https://www.booking.com/hotel/it/astoria-palace.it.html"
}'

Response

Status

Status Description
200 Update URL suggestion has been successfully submitted.