Request headers

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example

{
  "twitter_account": {
    "twitter_token": "TWITTER_TOKEN",
    "twitter_uid": "TWITTER_UID",
    "screen_name": "NAME",
    "logo_url": "LOGO_URL",
    "account_verified": true,
    "twitter_nickname": "SCREEN_NAME",
    "location": personalSettingsPage
  }
}

Success response body

{
  "success": true,
  "twitter_account": {
    "id": 3,
    "social_channel": "Twitter",
    "name": "USERNAME",
    "nickname": "USER NICKNAME",
    "logo": "LINK TO LOGO"
    "twitter_nickname": "GipperWorker"
  }
}

Error response body

# for admins
{
  "success": false,
  "message": ["To connect this social media account to your Personal, you must first remove it from your Workspace accounts"]
}
# for members
{
  "success": false,
  "message": ["This social account is already connected to your Workspace! Please ask example@mail.com for access"]
}

Errors

Code Description
422 Could not save the entity.

Params

Param name Description
twitter_account
required

Validations:

  • Must be a Hash

twitter_account[twitter_token]
required

Validations:

  • Must be a String

twitter_account[twitter_uid]
required

Validations:

  • Must be a String

twitter_account[screen_name]
required

Validations:

  • Must be a String

twitter_account[logo_url]
required

Validations:

  • Must be a String

twitter_account[account_verified]
optional

Validations:

  • Must be one of: true, false, 1, 0.

twitter_account[twitter_nickname]
required

Validations:

  • Must be a String

twitter_account[location]
optional

Validations:

  • Must be one of: workspaceSettingsPage, signUpForm, guidedWalkthrough, progressMeter, personalSettingsPage, templateBranding.