Skip to content
forgit api docs

Add social accounts for the authenticated user

POST
/user/social_accounts

Add one or more social accounts to the authenticated user’s profile.

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

API method documentation

Request Body required

Section titled “ Request Body required ”
Media type application/json
object
account_urls
required

Full URLs for the social media profiles to add.

Array<string>
Examples
Example default

Adding multiple social accounts 

{
  "account_urls": [
    "https://facebook.com/GitHub",
    "https://www.youtube.com/@GitHub"
  ]
}

Responses

Section titled “ Responses ”

201

Section titled “ 201 ”

Response

Media type application/json
Array<object>
Social account

Social media account

object
provider
required
string
url
required
string
Examples
Example default 
[
  {
    "provider": "twitter",
    "url": "https://twitter.com/github"
  }
]

304

Section titled “ 304 ”

Not modified

401

Section titled “ 401 ”

Requires authentication

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

403

Section titled “ 403 ”

Forbidden

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Section titled “ 404 ”

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

422

Section titled “ 422 ”

Validation failed, or the endpoint has been spammed.

Media type application/json
Validation Error

Validation Error

object
message
required
string
documentation_url
required
string
errors
Array<object>
object
resource
string
field
string
message
string
code
required
string
index
integer
value
One of:
string
nullable
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "errors": [
    {
      "resource": "example",
      "field": "example",
      "message": "example",
      "code": "example",
      "index": 1,
      "value": [
        "example"
      ]
    }
  ]
}