Request social media by platform

Starts a job to collect the profile of a business on one social media platform. Use it when you need one platform, not a summary.

Lifecycle: POST returns 201 and a request_id. Poll Get social media by platform with that request_id: 425 means not ready, and 200 means complete. If you send callback_url, Coris posts the result when it is done, as Handle async requests explains.

sequenceDiagram
  accTitle: Request social media by platform sequence diagram
  accDescr: Request social media by platform. You send POST .../social_media/{platform}/. 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 .../social_media/{platform}/
  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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The Coris ID of the establishment, from establishment.id in a search or profile.

string
enum
required

The social media platform: instagram or youtube. Any other value returns no profile and no error.

Allowed:
Body Params

Business Social Media Request

uri

A public HTTPS URL where Coris posts the result, if you want to skip polling.

integer

The minimum delay before the callback, in seconds, up to a recommended 3600. Send it if you might receive the callback before you store request_id.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Callback
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/html