Request account website

post

https://sandbox-api.coris.ai/api/v0_2/accounts/{account_id}/establishment/website/

Use this when you hold an account ID or reference_id: it starts a job to analyze the primary website of an account. For an establishment.id, use Request establishment website.

Lifecycle: poll Get account website with the request_id: 425 means not ready, and 200 means complete (see Handle async requests).

sequenceDiagram
  accTitle: Request account website sequence diagram
  accDescr: Request account website. You send POST .../website/. Coris replies 201 request_id. You send GET ?request_id=... Coris replies 425 not ready. You send GET ?request_id=... Coris replies 200 complete. Coris sends POST callback_url, if sent.
  participant You
  participant Coris
  You->>Coris: POST .../website/
  Coris-->>You: 201 request_id
  You->>Coris: GET ?request_id=...
  Coris-->>You: 425 not ready
  You->>Coris: GET ?request_id=...
  Coris-->>You: 200 complete
  Coris->>You: POST callback_url, if sent

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Callback

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/html

201The job started. Use request_id to get the result.

401The key is missing, or it is wrong for this host. Send Authorization: Token YOUR_API_KEY with a key issued for this environment.

403This feature is not enabled for your workspace, or your plan does not include it. Ask Coris support. A scoped key cannot use this route, and gets JSON with detail. Use a key without account limits.

404No item has this ID in your workspace. Check the ID and the environment.

429You passed a rate limit. If Retry-After is present, wait that many seconds, then retry. If it is absent, you hit the concurrency limit, so back off for a few seconds and reduce parallel calls.

500Coris could not complete the request. Retry with backoff. If it continues, contact support.