Unpause reads for an installation

Unpauses all scheduled reads for an installation. If no reads were paused, this will be a no-op. Accepts specific objects to unpause reads for in the request body.

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

Unpause reads for an installation

cURL

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

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"
    }
  ]
}

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 to unpause reads for.

note · string

A note to accompany the unpause.

Response

204

Reads unpaused successfully