▪ Add URL
Add URL API allows the user to suggest a specific network URL for a POI.
Warning
This API does not instantly add a URL to a POI.
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
POST
/v4/{billing_plan}/account/{account_id}/management/poi/{poi_id}/url
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 retrieve data 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 |
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 |
| *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 POST 'https://api.datappeal.io/v4/account/{account_id}/management/poi/XXeUNbmtYZTsH7UGvNfXWo/url' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \
-H 'Content-Type: application/json' \
-d '{
"network": "booking",
"url": "http://www.booking.com/hotel/it/astoria-palace.it.html"
}'
Response
Status
| Status | Description |
|---|---|
| 200 | Add URL suggestion has been successfully submitted. |