Skip to content
Dashboard
API Reference

Create Social Connection ​

Create a social account linking URL.

Creates a new social connection setup flow and returns it as connect_url.

After the user completes the setup flow, call GET /social/connections to find the new social_connection_id.

By default, each request creates a new social profile and uses one profile slot. Pass social_profile_id to open setup for an existing profile without creating another slot. To connect another account on the same platform, create a separate profile. If the organization has reached its profile limit, creating a new profile returns an error and no setup URL is created.

Set connection_name to the name you want displayed at the top of the hosted connection page. Names may be duplicated: two requests with the same name create separate profiles with distinct social_profile_id values. Use these IDs to identify profiles; names are labels, not unique identifiers. This label does not rename the connected YouTube channel or other social account.

To rename an existing profile, use Update Social Profile.

Request ​

bash
curl -X POST "https://api.mosaic.so/social/connections" \
  -H "Authorization: Bearer mk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "platform": "linkedin",
    "connection_name": "Motion LinkedIn"
  }'

Body Parameters ​

FieldTypeRequiredDescription
platformstringYesOne of: x, linkedin, instagram, facebook, tiktok, youtube.
connection_namestringNoName displayed on the hosted connection page for a new profile. Leading and trailing whitespace is trimmed; must contain 1–120 characters after trimming. Duplicate names are allowed. Omit to use a generated name. Does not rename an existing profile when social_profile_id is supplied.
social_profile_idstring (uuid)NoReuse an existing profile instead of creating a new one.
redirect_urlstring (url)NoOverride the post-connect redirect URL.

Response ​

json
{
  "platform": "linkedin",
  "social_profile_id": "d768e91a-d0ef-487f-8f0e-d6903cce3d5b",
  "connect_url": "https://api.mosaic.so/social/connect/v1.x6WRGq...c2fJ3A"
}