---
title: "Complete an OAuth connection"
method: POST
path: "/v1/connect/{platform}"
tags: ["Connect"]
---

# Complete an OAuth connection

`POST /v1/connect/{platform}`

## Request

- Base URL: `https://api.postzen.dev`
- URL: `https://api.postzen.dev/v1/connect/{platform}`
- Auth: HTTP bearer

Exchanges an OAuth authorization code for tokens and connects the account to the specified profile. This endpoint requires a read-write API key.

## Request body

- ConnectCompleteRequest
  - `code` string, required: OAuth authorization code returned by the platform.
  - `state` string, required: State returned by `GET /v1/connect/{platform}`.
  - `profileId` string, required: PostZen profile id used when the connection was initiated.

## Response `200`

Account connected.

- ConnectCompleteResponse
  - `message` string, required
  - `platform` 'twitter' | 'instagram' | 'tiktok' | 'linkedin' | 'facebook' | 'youtube' | 'threads' | 'pinterest' | 'bluesky' | 'telegram', required
  - `profileId` string, required
  - `status` 'connected' | 'needsReauth', required
  - `missingScopes` string[]
  - `connectedAccountCount` integer
  - `accounts` Account[]
    - `_id` string, required
    - `platform` 'twitter' | 'instagram' | 'tiktok' | 'linkedin' | 'facebook' | 'youtube' | 'threads' | 'pinterest' | 'bluesky' | 'telegram', required
    - `providerAccountId` string, required
    - `profileId` AccountProfileSummary, required
      - `_id` string, required
      - `name` string, required
      - `slug` string, required
      - `color` string, required
    - `username` string, required
    - `displayName` string, required
    - `profileUrl` string, uri
    - `avatarUrl` string, uri
    - `status` 'connected' | 'needsReauth' | 'disconnected' | 'disabled', required
    - `isActive` boolean, required
    - `connectedAt` string, date-time, required
    - `lastSyncedAt` string, date-time
    - `defaultBoardId` string: Default Pinterest board id. Present only when one has been selected for a Pinterest account.
    - `defaultBoardName` string: Default Pinterest board name. Present when Pinterest returned a name for the selected default board.

## Other responses

- `400`: Invalid request, expired OAuth state, or a failed platform callback. Callback failures return a camelCase error code with an optional `errorDescription`.
- `401`: Missing or invalid API key.
- `402`: A plan limit, missing payment method, or paused account prevents the requested operation.
- `403`: The API key does not have access to the profile, or the OAuth state belongs to a different user or profile.
- `404`: Resource not found.
- `500`: The platform token exchange failed or an unexpected server error occurred.

---

[API](https://skmtc.dev/postzen/apis/postzen-public-api.md) · [All operations](https://skmtc.dev/postzen/apis/postzen-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/postzen/apis/postzen-public-api/revisions/40863e3710ec?raw)
