Stop a widget (sets active=false)

1 min

POST

/v1/widgets/{id}/stop

Path Parameters

idstringrequired
Pattern
\d+

Query Parameters

websiteIdstring
Pattern
\d+

Responses

200Widget stopped

Widget
- idinteger
- namestringrequired
  Min Length
  1
  Max Length
  255
- clicksinteger
  Default
  0
- viewsinteger
  Default
  0
- conversionsinteger
  Default
  0
- goalsReachedinteger
  Default
  0
- valueinteger
  Default
  0
- extraValueinteger
  Default
  0
- submitsinteger
  Default
  0
- completionsinteger
  Default
  0
- contactsinteger
  Default
  0
- createDatestring<date-time>
  Format
  date-time
- updateDatestring<date-time>
  Format
  date-time
- activeboolean
  Default
  false
- typestringrequired
- startDatestring<date-time>
  Format
  date-time
- endDatestring<date-time>
  Format
  date-time
- primaryGoalIdinteger

403Token does not have write scope

404Widget not found

curl

curl --request POST \
     --url '/v1/widgets/{id}/stop?websiteId=string' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/v1/widgets/{id}/stop?websiteId=string", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("/v1/widgets/{id}/stop?websiteId=string")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = http.request(request)
puts response.read_body

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => '/v1/widgets/{id}/stop?websiteId=string',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'POST',
   CURLOPT_HTTPHEADER => array(
      'accept: application/json',
      'content-type: application/json'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

nodejs

var request = require('request');
var options = {
   'method': 'POST',
   'url': '/v1/widgets/{id}/stop?websiteId=string',
   'headers': {
      'accept': 'application/json',
      'content-type': 'application/json'
   }
};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

200

// Widget stopped
{
  "id": 0,
  "name": "",
  "clicks": 0,
  "views": 0,
  "conversions": 0,
  "goalsReached": 0,
  "value": 0,
  "extraValue": 0,
  "submits": 0,
  "completions": 0,
  "contacts": 0,
  "createDate": "",
  "updateDate": "",
  "active": false,
  "type": "",
  "startDate": "",
  "endDate": "",
  "primaryGoalId": 0
}

403

// Token does not have write scope

404

// Widget not found