installs_poll

POST

/consent/token

const url = 'https://api.canopyhq.dev/consent/token';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"poll_secret":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.canopyhq.dev/consent/token \
  --header 'Content-Type: application/json' \
  --data '{ "poll_secret": "example" }'

Request Body^required

application/json

object

poll_secret

required

What the vendor polls with. Issued once with the proposal; stored hashed.

string

Example^generated

{
  "poll_secret": "example"
}

Responses

200

Pending, expired, an initial grant with its key, or an update grant with no key. An update receipt remains pollable for the proposal’s ten-minute lifetime.

application/json

One of:

object

interval

required

integer format: int64

status

required

string

Allowed values: pending

Example

{
  "status": "pending"
}

400

The response body names the invalid field and reason.

404

No proposal answers this poll secret.

409

The key was collected already.

installs_poll

Request Bodyrequired

Examplegenerated

Responses

200

Example

400

404

409

Request Body^required

Example^generated