Skip to main content
POST
https://app.ocoya.com/api/_public/v1
/
social-profiles
/
connection-url
Generate social connection URL
curl --request POST \
  --url https://app.ocoya.com/api/_public/v1/social-profiles/connection-url \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "provider": "instagram"
}
'
{
  "url": "https://app.ocoya.com/api/social-connect/start?provider=instagram&workspaceId=cmayvq3hk00017apshay5qezu"
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
workspaceId
string
required

Ocoya workspace ID. Get one from GET /workspaces.

Example:

"cmayvq3hk00017apshay5qezu"

Body

application/json
​
provider
enum<string>
required

Social network used for the connection flow.

Available options:
facebook,
instagram,
x,
linkedin,
pinterest
Example:

"instagram"

Response

Success

​
url
string
required

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

Example:

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