post/users/@me/connections

Initiate connection

Initiates a new external service connection and returns verification instructions. No database record is created until verification succeeds.

initiate_connection

Request body

application/json

json

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "bsky",
        "domain"
      ],
      "description": "The type of connection to create"
    },
    "identifier": {
      "type": "string",
      "minLength": 1,
      "maxLength": 253,
      "description": "The connection identifier (handle or domain)"
    },
    "visibility_flags": {
      "$ref": "#/components/schemas/Int32Type"
    }
  },
  "required": [
    "type",
    "identifier"
  ]
}

Responses

201

Success

json

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "description": "The verification token to place in DNS or profile"
    },
    "type": {
      "type": "string",
      "enum": [
        "bsky",
        "domain"
      ],
      "description": "The type of connection being verified"
    },
    "id": {
      "type": "string",
      "description": "The connection identifier (handle or domain)"
    },
    "instructions": {
      "type": "string",
      "description": "Human-readable instructions for completing verification"
    },
    "initiation_token": {
      "type": "string",
      "description": "Signed token the client sends back at verify time"
    }
  },
  "required": [
    "token",
    "type",
    "id",
    "instructions",
    "initiation_token"
  ]
}

400

Bad Request - The request was malformed or contained invalid data

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

401

Unauthorized - Authentication is required or the token is invalid

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

403

Forbidden - You do not have permission to perform this action

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

429

Too Many Requests - You are being rate limited

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "enum": [
        "RATE_LIMITED"
      ]
    },
    "message": {
      "type": "string"
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message",
    "retry_after"
  ]
}

500

Internal Server Error - An unexpected error occurred

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}