Skip to main content
POST
/
projects
/
{projectIdOrName}
/
integrations
/
{integrationId}
/
installations
/
{installationId}
:pause
Pause reads for an installation
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>"
}'
This response does not have an example.

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

Reads paused successfully