Another API description

Resources

Campaigns

Resource Description
GET /api/v3/campaigns/:id Get campaign by ID

Colors

Resource Description
GET /api/v3/colors List of users colors
POST /api/v3/colors Create user color
PUT /api/v3/colors/:id Update user color
DELETE /api/v3/colors/:id Delete user color
POST /api/v3/colors/bulk_create Create multiple colors. Last updates: 11/08/23

Community login

Resource Description
POST /api/v3/oauth/confirm_authentication FieldHouse auth
POST /api/v3/oauth/confirm_auth FieldHouse auth for current user

Contact us

Resource Description
GET /api/v3/contact_us Contact Us

Content requests

Resource Description
GET /api/v3/content_requests List of Content Requests
GET /api/v3/content_requests/:token Get Content Request
POST /api/v3/content_requests Create Content Request
PUT /api/v3/content_requests/:id Update Content Request
PUT /api/v3/content_requests/:token/complete Complete Content Request
DELETE /api/v3/content_requests/:id Destroy Content Request

Coupons

Resource Description
GET /api/v3/coupons Get coupon by name

Donor metrics

Resource Description
POST /api/v3/donor_metrics Create Donor Metric
PUT /api/v3/donor_metrics/:id Update Donor Metric

Facebook accounts

Resource Description
GET /api/v3/facebook_accounts/accounts_list Get Facebook Accounts List FB and IG

Facebook pages

Resource Description
POST api/v3/facebook_pages Create User Facebook Pages. Last update: 08/08/23
DELETE api/v3/facebook_pages/:id Destroy User Facebook Page
PUT api/v3/facebook_pages/:id/refresh_avatar Refresh avatar link

Favorite presets

Resource Description
POST /api/v3/presets/:preset_id/favorite_presets Mark as Favorite
DELETE /api/v3/presets/:preset_id/favorite_presets Unmark as Favorite

Favorite templates

Resource Description
POST /api/v3/templates/:template_id/favorite_templates Mark template as favorite of the current user
DELETE /api/v3/templates/:template_id/favorite_templates Unmark template as favorite of the current user

Folders

Resource Description
GET /api/v3/folders List of media_folders
GET /api/v3/folders/:id Show media_folder
POST /api/v3/folders Create media_folder
PUT /api/v3/folders/:id Update media_folder
DELETE /api/v3/folders/:id Delete media_folder
POST /api/v3/folders/:id/share_with_team Share with team
POST /api/v3/folders/bulk_share_with_team bulk share with team
PUT /api/v3/folders/move Move folder to other folder
DELETE /api/v3/folders/bulk_destroy Delete folders

Fonts

Resource Description
GET /api/v3/fonts List of workspace fonts

Hidden notifications

Resource Description
POST /api/v3/users/hidden_notifications Create hidden notification

Instagram accounts

Resource Description
POST api/v3/instagram_accounts Create User Instagram Accounts
DELETE /api/v3/instagram_accounts/:id Delete User Instagram Account
PUT api/v3/instagram_accounts/:id/refresh_avatar Refresh avatar link

Institutions

Resource Description
GET /api/v3/institutions List of logos

Invites

Resource Description
GET /api/v3/invites List of workspace invites
GET /api/v3/invites/:id Checking for existence of an invite. Last update: 03/08/23
POST /api/v3/invites Create invite to workspace
DELETE /api/v3/invites/:id Delete invite
GET /api/v3/invites/:id/resend_email Resend invite`s email
PUT /api/v3/invites/:id/accept Accept invite
PUT /api/v3/invites/:id/decline Decline invite

Logins

Resource Description
POST /api/v3/users/sign_in Authenticate user. Updated: 18/12/2023
DELETE /api/v3/users/sign_out Logout user

Media files

Resource Description
GET /api/v3/folders/:folder_id/media_files List of media files. Last update: 10/04/24
GET /api/v3/media_files/search search media file in Gallery. Last update: 10/04/24
GET /api/v3/media_files/:id Show media file. Last update: 10/04/24
POST /api/v3/folders/:folder_id/media_files Create media file. Last update: 10/04/24
POST /api/v3/folders/:folder_id/media_files/bulk_create Bulk create media files
PUT /api/v3/media_files/:id Update media file. Last update: 10/04/24
DELETE /api/v3/media_files/:id Delete media file
POST /api/v3/media_files/:id/share_with_team Share with team
PUT /api/v3/media_files/move Move user_media_files. Last update: 10/04/24
GET /api/v3/media_files/bulk_show_by_s3_keys search by s3_keys. Added: 15/04/24
POST api/v3/media_files/:s3_key/remove_bg

Onboarding

Resource Description
POST /api/v3/users/onboarding Check users email and send properties on hubspot

Passwords

Resource Description
POST /api/v3/users/password Send reset password link
PUT /api/v3/users/password Reset password with token

Pendos

Resource Description
GET /api/v3/users/pendo get info for pendo

Pictures

Resource Description
POST /api/v3/pictures Create picture

Plans

Resource Description
GET /api/v3/plans List of plans with plan details

Preset folders

Resource Description
GET /api/v3/preset_folders List of preset_folders
GET /api/v3/preset_folders/:id Show preset_folder
POST /api/v3/preset_folders Create preset_folder
PUT /api/v3/preset_folders/:id Update preset_folder
DELETE /api/v3/preset_folders/:id Delete media_folder
POST /api/v3/preset_folders/:id/share_with_team Share with team
POST /api/v3/preset_folder/bulk_share_with_team Bulk share with team
PUT /api/v3/preset_folders/move Move folder to other folder
DELETE /api/v3/preset_folders/bulk_destroy Delete folders

Presets

Resource Description
GET /api/v3/presets List of preset. Last update: 27/02/24
GET /api/v3/presets/:id Get preset. Last update: 04/10/23
POST /api/v3/presets Create preset. Last update: 04/10/23
PUT /api/v3/presets/:id Update preset. Last update: 04/10/23
DELETE /api/v3/presets/:id Delete preset
PUT /api/v3/presets/move Move presets to other folder
GET /api/v3/presets/check_for_scheduled_posts Check presets for having scheduled posts
GET /api/v3/presets/:id/public_show Get published newsletter preset. Last update: 05/03/24

Registrations

Resource Description
GET /api/v3/users/validate Registration form validation. DEPRECATED
POST /api/v3/users/sign_up Registration new user
PUT /api/v3/users/sign_up_invited_user Registration invited user

Social accounts

Resource Description
GET /api/v3/social_accounts List of users social accounts. Last Update: 08/08/23
GET /api/v3/social_accounts/social_accounts_list List of users social accounts in special format

Social media post wrappers

Resource Description
GET /api/v3/social_media_post_wrappers List of sheduled posts
GET /api/v3/social_media_post_wrappers/:id Get current social_post
PUT /api/v3/social_media_post_wrappers/:id Update current social_post
DELETE /api/v3/social_media_post_wrappers/:id Delete current social_post

Social media posts

Resource Description
POST /api/v3/social_media_posts Create social media post

Social medias

Resource Description
GET /api/v3/social_medias List of sheduled posts
GET /api/v3/social_medias/:social_media_id/:social_media_type Get current social_post
PUT /api/v3/social_medias/:social_media_id/:social_media_type Update current social_post
DELETE /api/v3/social_medias/:social_media_id/:social_media_type Delete current social_post

Sponsors

Resource Description
POST /api/v3/sponsors Create Sponsors
PUT /api/v3/sponsors/id: Update Sponsors

Subscriptions

Resource Description
POST /api/v3/subscriptions Create subscription
GET /api/v3/subscriptions/edit Get Proration

Tags

Resource Description
GET /api/v3/tags List of tags by filter_type
GET /api/v3/tags/:id Show tag templates

Team calendars

Resource Description
GET /api/v3/team_calendars List of Team Calendars
GET /api/v3/team_calendars/:id Get Team Calendar
POST /api/v3/team_calendars Create Team Calendar
POST api/v3/team_calendars/bulk_create Bulk create from csv
PUT /api/v3/team_calendars/:id Update Team Calendar
DELETE /api/v3/team_calendars/:id Delete Team Calendar

Team users

Resource Description
POST /api/v3/teams/:team_id/team_users Add new users to team
PUT /api/v3/teams/:team_id/team_users/:id Update user role
DELETE /api/v3/teams/:team_id/team_users/:id Remove user from team

Teams

Resource Description
GET /api/v3/teams List of teams
GET /api/v3/teams/workspace_list List of workspace teams
POST /api/v3/teams Create workspace team
PUT /api/v3/teams/:id Update workspace team
DELETE /api/v3/teams/:id Delete workspace team
GET /api/v3/teams/list_for_sharing List for sharing
GET /api/v3/teams/social_accounts_list_for_sharing List for sharing social accounts

Template videos

Resource Description
POST /api/v3/template_videos Create picture

Templates

Resource Description
GET /api/v3/templates List of user templates
GET /api/v3/templates/:id Get one separate user template

Tracking events

Resource Description
POST /api/v3/tracking_events Tracking Events

Transfering admins

Resource Description
PUT /api/v3/transfering_admins Transfering Admins

Twitter accounts

Resource Description
POST /api/v3/twitter_accounts Create Twitter Account for User
GET /api/v3/twitter_accounts/search_users Search many users. Last Update: 01/11/23
DELETE /api/v3/twitter_accounts/:id Delete User Twitter Account

Upload file roles

Resource Description
GET api/v3/upload_file_role Get UPLOAD_FILE_ROLE

Users

Resource Description
GET /api/v3/users Show user. Last update: 20/12/23
PUT /api/v3/users Update User. Last update: 11/08/23
PUT /api/v3/users/clicked_upgrade User clicked upgrade

Verify instagram accounts

Resource Description
GET /api/v3/verify_instagram_accounts Verify Instagram Accounts. Last update: 15/09/23

Verify social accounts

Resource Description
GET /api/v3/verify_social_accounts Verify Social Accounts. Last update: 08/08/23
GET /api/v3/verify_social_accounts/verify_accounts_for_social/:type New Verify Social Accounts. Last update: 12/04/24

Workspace color

Resource Description
GET /api/v3/workspaces/colors List of workspaces colors
POST /api/v3/workspaces/colors Create workspace color
PUT /api/v3/workspaces/colors/:id Update workspace color
DELETE /api/v3/workspaces/colors/:id Delete user color
POST /api/v3/workspaces/colors/bulk_create

Workspace facebook accounts

Resource Description
GET /api/v3/workspaces/facebook_accounts/accounts_list Get Facebook Accounts List FB and IG from workspaces

Workspace facebook pages

Resource Description
POST api/v3/workspaces/facebook_pages Create Workspace Facebook Pages. Last update: 08/08/23
PUT api/v3/workspaces/facebook_pages/:id Update Facebook Page. Last update: 08/08/23
DELETE api/v3/workspaces/facebook_pages/:id Destroy Workspace Facebook Page
PUT api/v3/workspaces/facebook_pages/:id/refresh_avatar Refresh avatar link

Workspace fonts

Resource Description
GET /api/v3/workspaces/fonts List of users fonts
POST /api/v3/workspaces/fonts Create font
PUT /api/v3/workspaces/fonts/:id Update font
DELETE /api/v3/workspaces/fonts/:id Delete font

Workspace instagram accounts

Resource Description
POST api/v3/workspaces/instagram_accounts Create Workspace Instagram Accounts
PUT /api/v3/workspaces/instagram_accounts/:id Update Instagram Account
DELETE /api/v3/workspaces/instagram_accounts/:id Delete Workspace Instagram Account
PUT api/v3/workspaces/instagram_accounts/:id/refresh_avatar Refresh avatar link

Workspace logos

Resource Description
GET /api/v3/workspaces/workspace_logos List of Workspace Logos. Last update: 16/10/23
POST /api/v3/workspaces/workspace_logos Create Workspace Logo. Last update: 29/11/23
PUT /api/v3/workspaces/workspace_logos/:id Update Workspace Logo. Last update: 16/10/23
DELETE /api/v3/workspaces/workspace_logos/:id Destroy Workspace Logo. Last update: 16/10/23

Workspace social accounts

Resource Description
GET /api/v3/workspaces/social_accounts List of workspaces social accounts. Last update: 18/08/23

Workspace twitter accounts

Resource Description
POST /api/v3/workspaces/twitter_accounts Create Twitter Account for Workspace
PUT /api/v3/workspaces/twitter_accounts/:id Update Twitter Account
GET /api/v3/workspaces/twitter_accounts/search_users Search many users
DELETE /api/v3/workspace/twitter_accounts/:id Delete Workspace Twitter Account

Workspace users

Resource Description
PUT /api/v3/workspace_users/:id Update User Role in Workspace
DELETE /api/v3/workspace_users/:id Delete User from Workspace
DELETE /api/v3/workspace_users/bulk_destroy Remove users from Workspace

Workspaces

Resource Description
GET /api/v3/workspaces Show workspace
PUT api/v3/workspaces Update workspace. Last Update: 02/08/23
GET api/v3/workspaces/can_use_site Check workspace can use site?