Connect

Complete OAuth callback

Exchange the OAuth authorization code for tokens and connect the account to the specified profile.

Facebook, Google Business Profile, Snapchat and WhatsApp are not accepted here: their account identity is a destination chosen after OAuth, which this single-shot exchange cannot do. Connect them through the redirect flow from GET /v1/connect/{platform}, or, for WhatsApp Embedded Signup, through POST /v1/connect/whatsapp/embedded-signup.

post/v1/connect/{platform}

Path parameters

platform'instagram' | 'twitter' | 'threads' | 'linkedin' | 'youtube' | 'tiktok' | 'reddit' | 'pinterest' required

Social platform to complete the connect for. Discord, Slack and Telegram are absent because they are served by their own dedicated routes, documented separately.

Request body

codestring required
statestring required
profileIdstring required

Response

Account connected

Changes

Changed in 2 of the 56 revisions of this API.1112

  • f5bd490b573111See the full diff
    • ●

      added the new card_verification_required enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 44b6b1ca2a8b111See the full diff
    • ▲

      the path request parameter platform was restricted to a list of enum values

      request-parameter-became-enum

    • ○

      added the new enum value instagram to the path request parameter platform

      request-parameter-enum-value-added

    • ○

      added the new enum value linkedin to the path request parameter platform

      request-parameter-enum-value-added

    • ○

      added the new enum value pinterest to the path request parameter platform

      request-parameter-enum-value-added

    • ○

      added the new enum value reddit to the path request parameter platform

      request-parameter-enum-value-added

    • ○

      added the new enum value threads to the path request parameter platform

      request-parameter-enum-value-added

    • ○

      added the new enum value tiktok to the path request parameter platform

      request-parameter-enum-value-added

    • ○

      added the new enum value twitter to the path request parameter platform

      request-parameter-enum-value-added

    • ○

      added the new enum value youtube to the path request parameter platform

      request-parameter-enum-value-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog