Skip to main content

socialAccount.connect

post/v1/social/accounts/connect/{platform}

socialAccount.connect

Request

Parameters

NameInTypeDescription
platform*pathstringNo description

Body

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "callback_url": {
            "type": "string",
            "format": "uri"
          }
        },
        "required": [
          "callback_url"
        ]
      }
    }
  }
}

Responses

200No description
Schema Structure
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"authorization_url": {
"type": "string"
},
"state": {
"type": "string"
}
},
"required": [
"authorization_url",
"state"
]
}
},
"required": [
"success",
"data"
]
}
400No description
Schema Structure
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"PLATFORM_NOT_SUPPORTED"
]
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
]
}
},
"required": [
"success",
"error"
]
}
422Validation error
Schema Structure
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Errors overview."
},
"errors": {
"type": "object",
"description": "A detailed description of each field that failed validation.",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"message",
"errors"
]
}