Pause reads for an installation

Pauses all scheduled reads for an installation. If reads are already paused, this will be a no-op. Accepts specific objects to pause reads for in the request body.

POST /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}:pause

Pause reads for an installation

cURL

curl --request POST \
  --url https://read.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}:pause \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "objects": [
    [
      "account",
      "contact"
    ]
  ],
  "note": "<string>"
}
'

import requests

url = "https://read.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}:pause"

payload = {
    "objects": [["account", "contact"]],
    "note": "<string>"
}
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({objects: [['account', 'contact']], note: '<string>'})
};

fetch('https://read.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}:pause', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://read.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}:pause",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'objects' => [
        [
                'account',
                'contact'
        ]
    ],
    'note' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://read.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}:pause"

	payload := strings.NewReader("{\n  \"objects\": [\n    [\n      \"account\",\n      \"contact\"\n    ]\n  ],\n  \"note\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://read.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}:pause")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"objects\": [\n    [\n      \"account\",\n      \"contact\"\n    ]\n  ],\n  \"note\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://read.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}:pause")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"objects\": [\n    [\n      \"account\",\n      \"contact\"\n    ]\n  ],\n  \"note\": \"<string>\"\n}"

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

400

{
  "type": "about:blank",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Bad Request",
  "status": 400,
  "detail": "The input message is incorrect",
  "instance": "123456-1234-1235-4567489798",
  "issues": [
    {
      "type": "about:blank",
      "detail": "exampleNumericProperty should be numeric",
      "in": "path",
      "name": "exampleNumericProperty",
      "value": "abc"
    },
    {
      "type": "about:blank",
      "title": "Input isn't valid with respect to schema",
      "detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
      "in": "body",
      "name": "items[0].examplePropertyWithPattern",
      "value": "a2345678901"
    }
  ]
}

{
  "type": "urn:problem-type:exampleOrganization:exampleProblem",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Description of the type of problem that occurred",
  "status": 400,
  "detail": "Description of specific occurrence of the problem",
  "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}

Authorizations

X-Api-Key · string · header · required

Path Parameters

projectIdOrName · string · required

The Ampersand project ID or project name.

integrationId · string · required

The integration ID.

installationId · string · required

The Ampersand installation ID.

Body

application/json

objects · string[]

The names of the objects (mapped or unmapped) to pause reads for. If not provided, all objects will be paused.

note · string

A note to accompany the pause.

Response

204

Reads paused successfully