Workspace_instagram_accounts

>>>

POST api/v3/workspaces/instagram_accounts
Create Workspace Instagram Accounts

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 ↑

{
  "facebook_account": {
    "fb_token": "FB_TOKEN",
    "rb_uid": "FB_UID",
    "location": workspaceSettingsPage
  },
  "ig_accounts": [
    {
      "id": "IG_ACCOUNT_UID",
      "username": "Ov_dev_sl_2",
      "fb_token": "ACCESS_TOKEN",
      "profile_picture_url": "https://scontent-iad3-1.xx.fbcdn.net/v/t39.30808-1/344871424_1571948339950824_3238105955092709413_n.png?stp=cp0_dst-png_p50x50&_nc_cat=111&ccb=1-7&_nc_sid=dbb9e7&_nc_ohc=nbK0WSHJcMkAX8hTPGc&_nc_ht=scontent-iad3-1.xx&edm=AGaHXAAEAAAA&oh=00_AfAYv8ssm2oogVS5zx2wxwFEwMQcYfDotdUQNct5apnzpg&oe=6457D34B"
    },
    ...
  ]
}

Success response body ↑

{
  "success": false,
  "ig_accounts": [],
  "message": [
    "Instagram account IG_NAME not connected. To connect this social media account to your Workspace, you must first remove it from your Personal accounts"
  ]
}

Errors

Code Description
422 Could not save the entity.

Params

Param name Description
facebook_account
required

Validations:

  • Must be a Hash
facebook_account[fb_token]
required

Validations:

  • Must be a String
facebook_account[fb_uid]
required

Validations:

  • Must be a String
facebook_account[location]
optional

Validations:

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

Validations:

  • Must be an Array of nested elements
ig_accounts[fb_token]
required

Validations:

  • Must be a String
ig_accounts[ig_user_id]
required

Validations:

  • Must be a String
ig_accounts[ig_user_name]
required

Validations:

  • Must be a String
ig_accounts[ig_profile_picture_url]
required

Validations:

  • Must be a String
>>>

PUT /api/v3/workspaces/instagram_accounts/:id
Update Instagram Account

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 ↑

{
  "instagram_account": {
    "nickname": "NICKNAME",
    "team_ids": [1, ...]
  }
}

Success response body ↑

{
  "id": 1,
  "ig_user_name": "USER NAME",
  "ig_profile_picture_url": "PROFILE PICTURE URL",
  "nickname": "NICKNAME",
  "teams_count": 1
}

Params

Param name Description
id
required

ID of Instagram Account

Validations:

  • Must be a Integer
instagram_account
required

Validations:

  • Must be a Hash
instagram_account[nickname]
optional

Validations:

  • Must be a String
instagram_account[team_ids]
required , nil allowed

Validations:

  • Must be an array of Integer
>>>

DELETE /api/v3/workspaces/instagram_accounts/:id
Delete Workspace Instagram Account

Request headers ↑

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

Success response body ↑

{
  "success": true,
  "instagram_account_id": 1
}

Params

Param name Description
id
required

ID of Instagram Account

Validations:

  • Must be a Integer