v1

latestOpenAPI 3.1.02026-08-0616024.0 KB

Generate social connection URL

Returns a browser URL that starts connecting a social network to a workspace. Open the returned URL while signed in to Ocoya to approve OAuth and select profiles.

post/social-profiles/connection-url

Query parameters

workspaceIdstring required
Example:cmayvq3hk00017apshay5qezu

Ocoya workspace ID. Get one from GET /workspaces.

Request body

provider'facebook' | 'instagram' | 'x' | 'linkedin' | 'pinterest' required

Social network used for the connection flow.

Example request

{
  "provider": "instagram"
}

Response

Success

urlstring required

Browser URL to open while signed in to Ocoya to start the connection flow.

Example response

{
  "url": "https://app.ocoya.com/api/social-connect/start?provider=instagram&workspaceId=cmayvq3hk00017apshay5qezu"
}