Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Method description

...

Create a new boost for the client {instance_id}.

...

Code Block
titleExample application/json
collapsetrue
{
    "activation_date": null,"2016-10-25T22:00:00",
    "created_on": "2017-08-08T15:27:4352",
    "deactivation_date": null,"2017-04-25T22:00:00",
    "enabled": truefalse,
    "extra": {
        "user": "-"
    },
    "keywords": [
        "rafflering"
    ],
    "langlangs": [
        "en"
    ],
    "match_all": false,references": [
        {
            "titleref": "Raffle19430508",
            "typetitle": "DIRECT",Eternity Ring"
        }
   "url": "https://empathybroker.com/raffle" ],
    "weightzero_results": 0false
}

See Play Service models for details. All non-optional fields must be included in the request.

...

Type: application/json

Code Block
{
    "activation_date": null"2016-10-25T22:00:00",
    "created_on": "2017-08-08T15:27:4352",
    "deactivation_date": null,"2017-04-25T22:00:00",
    "enabled": truefalse,
    "extra": {
        "user": "-"
    },
    "id": "5989d86fe6ece90012a927665989d878e6ece90011a9276c",
  "image_url": null,   "keywords": [
        "rafflering"
    ],
    "langlangs": [
        "en"
    ],
    "match_all": false,references": [
        {
          "titleref": "Raffle19430508",
          "typetitle": "DIRECT"Eternity Ring"
        }
    ],
    "updated_on": "2017-08-08T15:27:4352",
 
"url": "https://empathybroker.com/raffle",   "weightzero_results": 0false
}

Also, a Location header will point to the URL for the boost that was just created.

...

Code Block
titleExample application/json
collapsetrue
{
  "code": 400,
  "details": "\"rows\" must be in range 10-200",
  "message": "Bad Request",
  "status": "error"
}

401 - the user performing the action doesn't meet the security criteria

Type: application/json

Code Block
titleExample application/json
collapsetrue
{
  "code": 401,
  "details": "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",
  "status": "error"
}

...