Method description
Update an existing existent link for the requested client {instance_id}.
...
URI Parameters
None
Request Data
The PUT request must include a single object with the updated link data.
Requests
Body
application/json
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"enabled": false,
} |
See Play Service models for for details. The request may include only the fields that are to be updated.
To remove a field (and set the default) set it to null. It is an error to remove a required field or change the link type.
Images are to be updated using the /images endpoint.
Example to disable a link:
...
Responses
201 - item has been updated
Type: application/json
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"activation_date": null,
"created_on": "2017-08-08T15:27:43",
"deactivation_date": null,
"enabled": false,
"extra": {
"user": "-"
},
"id": "5989d86fe6ece90012a92766",
"image_url": null,
"keywords": [
"raffle"
],
"lang": "en",
"match_all": false,
"title": "Raffle",
"type": "DIRECT",
"updated_on": "2017-08-08T15:27:43",
"url": "https://empathybroker.com/raffle",
} |
Response format and codes
...
"weight": 0
} |
Also, a Location header will point to the URL for the boost that was just created.
400 - Invalid parameters. Error response will include details
...
The response will contain the updated link data.
...
Type: application/json
| Code Block | ||||
|---|---|---|---|---|
| ||||
{ "code": "validation_error", "details": [ { "message": "1 is not of type 'boolean'", "path": ".enabled" } ], "titlemessage": "LinkError validating TitleJSON", "urlstatus": "https://example.com"error" } |
401 - the user performing the action doesn't meet the security criteria
Type: application/json
| Code Block | ||||
|---|---|---|---|---|
| ||||
{ "code": 401, "keywordsdetails": ["one keyword", "another keyword"]"The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.", "message": "Unauthorized", "langstatus": "enerror" } |