Platform tools
Network-specific tools on a connected account: Google Business Profile listing, reviews, media and verification; Facebook Pages; LinkedIn organizations and mentions; Instagram stories, audio and discovery; Pinterest boards; YouTube playlists and transcripts; Reddit subreddits, flairs and votes; TikTok creator info; Discord server management; Bluesky settings.
platform_tools- GBP reviews5
- GBP automation3
- GBP location details2
- GBP attributes2
- GBP attribute metadata1
- GBP services2
- GBP food menus2
- GBP media3
- GBP place actions4
- GBP verifications4
- GBP locations3
- Facebook page2
- Webhook subscription2
- Business partners3
- LinkedIn organizations1
- LinkedIn organization1
- LinkedIn mentions1
- Instagram6
- Follow status1
- Pinterest boards3
- YouTube playlists3
- YouTube captions1
- Reddit subreddits3
- Reddit flairs2
- Reddit vote1
- TikTok4
- Bluesky settings2
- Discord settings2
- Discord channels1
- Discord21
GBP reviews
List Google Business reviews
/accounts/{accountId}/gmb-reviewsReviews of the location with average rating and total count (cursor paging, ≤50 per page). Optional location_id targets another location of the same Google login.
Try it with MCPAsk your agent to call list-gmb-reviews (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
limitintegerdefault: 501–50
cursorstring≤ 2048 characters
order_bystringupdate_time descupdateTime descratingrating desc
Returns object
objectstringrequiredlist
account_idstringlocation_idstring | nullaverage_ratingnumber | nulltotal_review_countinteger | nulldataarray of objectrequiredShow 22 item attributes
objectstringgmb_review
idstringnamestring | nulllocation_idstring | nullratinginteger | nulltextstring | nulltext_translatedstring | nulltext_originalstring | nullauthorstring | nullauthor_avatar_urlstring | nullauthor_is_anonymousbooleancreated_atstring | nullupdated_atstring | nullhas_replybooleanreplystring | nullreply_updated_atstring | nullreply_statestring | nullreply_policy_violationobject | string | nullreply_urlstring | nullhas_photosbooleanphoto_countintegermediaarray of objectShow 3 item attributes
typestringurlstring | nullthumbnail_urlstring | nullhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Batch get Google Business reviews
/accounts/{accountId}/gmb-reviews/batchReviews across up to 50 locations of the same Google account in one call.
Try it with MCPAsk your agent to call batch-get-gmb-reviews (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Body object
location_idsarray of stringrequired1–50 items
google_account_idstring≤ 300 characters
limitinteger1–50
cursorstring≤ 2048 characters
order_bystringupdate_time descupdateTime descratingrating desc
ignore_rating_only_reviewsbooleanReturns object
objectstringrequiredlist
account_idstringgoogle_account_idstring | nulldataarray of objectrequiredShow 3 item attributes
objectstringgmb_location_review
location_idstring | nullreviewobjectShow 22 child attributes
objectstringgmb_review
idstringnamestring | nulllocation_idstring | nullratinginteger | nulltextstring | nulltext_translatedstring | nulltext_originalstring | nullauthorstring | nullauthor_avatar_urlstring | nullauthor_is_anonymousbooleancreated_atstring | nullupdated_atstring | nullhas_replybooleanreplystring | nullreply_updated_atstring | nullreply_statestring | nullreply_policy_violationobject | string | nullreply_urlstring | nullhas_photosbooleanphoto_countintegermediaarray of objectShow 3 item attributes
typestringurlstring | nullthumbnail_urlstring | nullhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Get a Google Business review
/accounts/{accountId}/gmb-reviews/{reviewId}Try it with MCPAsk your agent to call get-gmb-review (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
reviewIdstringrequired1–512 characters
Query parameters
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
Returns object
objectstringgmb_review
idstringnamestring | nulllocation_idstring | nullratinginteger | nulltextstring | nulltext_translatedstring | nulltext_originalstring | nullauthorstring | nullauthor_avatar_urlstring | nullauthor_is_anonymousbooleancreated_atstring | nullupdated_atstring | nullhas_replybooleanreplystring | nullreply_updated_atstring | nullreply_statestring | nullreply_policy_violationobject | string | nullreply_urlstring | nullhas_photosbooleanphoto_countintegermediaarray of objectShow 3 item attributes
typestringurlstring | nullthumbnail_urlstring | nullResponses
Reply to a Google Business review
/accounts/{accountId}/gmb-reviews/{reviewId}/replyCreates or overwrites the owner reply (≤4096 bytes). Set automated: true for replies sent without a human pressing send (AI agents, workflows); they need the location opt-in (PATCH …/gmb-automation) and are audited. Emits review.replied.
Try it with MCPAsk your agent to call reply-to-gmb-review (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
reviewIdstringrequired1–512 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
commentstringrequired1–4096 characters
automatedbooleandefault: falsetrue when no human pressed send (AI agents, workflows, auto-responders); needs the location opt-in
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
Returns object
objectstringgmb_review_reply
review_idstringnamestring | nullcommentstring | nullupdated_atstring | nullreply_statestring | nullautomatedbooleandeletedbooleanResponses
Delete a Google Business review reply
/accounts/{accountId}/gmb-reviews/{reviewId}/replyTry it with MCPAsk your agent to call delete-gmb-review-reply (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
reviewIdstringrequired1–512 characters
Query parameters
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
Returns object
objectstringgmb_review_reply
review_idstringnamestring | nullcommentstring | nullupdated_atstring | nullreply_statestring | nullautomatedbooleandeletedbooleanResponses
GBP automation
Get the Google Business automation opt-in
/accounts/{accountId}/gmb-automationWhether the business opted in to automated review replies / listing edits for the location (Google policy).
Try it with MCPAsk your agent to call get-gmb-automation (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
Returns object
objectstringgmb_automation
idstring | nullaccount_idstringlocation_idstringautomated_review_repliesbooleanautomated_listing_editsbooleanconsent_textstring | nullopted_in_byobject | nullShow 3 child attributes
typestringidstring | nullnamestring | nullopted_in_atstring | nullupdated_atstring | nullResponses
Update the Google Business automation opt-in
/accounts/{accountId}/gmb-automationRecord (or revoke) the business’s express opt-in for automated review replies and listing edits on a location. Every change is written to the automation audit log.
Try it with MCPAsk your agent to call update-gmb-automation (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Body object
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
automated_review_repliesbooleanautomated_listing_editsbooleanconsent_textstring | null≤ 2000 characters
Returns object
objectstringgmb_automation
idstring | nullaccount_idstringlocation_idstringautomated_review_repliesbooleanautomated_listing_editsbooleanconsent_textstring | nullopted_in_byobject | nullShow 3 child attributes
typestringidstring | nullnamestring | nullopted_in_atstring | nullupdated_atstring | nullResponses
List the Google Business automation audit log
/accounts/{accountId}/gmb-automation/audit-logOpt-in changes and automated actions (automated review replies) for the account, newest first.
Try it with MCPAsk your agent to call list-gmb-automation-audit (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
pageintegerdefault: 1≥ 1
limitintegerdefault: 201–100
actionstringopt_in_review_repliesopt_out_review_repliesopt_in_listing_editsopt_out_listing_editsautomated_review_reply
Returns object
objectstringrequiredlist
dataarray of objectrequiredShow 8 item attributes
objectstringgmb_automation_audit
idstringaccount_idstringlocation_idstringactionstringactorobject | nullShow 3 child attributes
typestringidstring | nullnamestring | nulldetailsobjectcreated_atstring | nullpageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
GBP location details
Get Google Business location details
/accounts/{accountId}/gmb-location-detailsThe Business Information Location (title, address, hours, categories, profile, phone, website…) plus status flags. Optional location_id targets another location of the same Google login.
Try it with MCPAsk your agent to call get-gmb-location-details (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
read_maskstring≤ 2000 characters
Returns object
objectstringgmb_location_details
account_idstringlocation_idstring | nullflagsobject | nulllocationobjectupdate_maskarray of string | nullvalidate_onlybooleanwarningsarray of stringResponses
Update Google Business location details
/accounts/{accountId}/gmb-location-detailsPATCH native Location fields (snake_case). update_mask is inferred from the body keys when omitted; validate_only dry-runs. Title / address / category edits may trigger re-verification (see warnings). Rate limited to 10 edits/min/location.
Try it with MCPAsk your agent to call update-gmb-location-details (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Body object
Native Business Information Location fields (snake_case) plus update_mask / validate_only / location_id
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
update_maskstring | array of stringvalidate_onlybooleantitlestringregular_hoursobjectspecial_hoursobjectmore_hoursarray of objectprofileobjectwebsite_uristringphone_numbersobjectcategoriesobjectservice_itemsarray of objectstore_codestringlabelsarray of stringstorefront_addressobjectservice_areaobjectopen_infoobjectlatlngobjectad_words_location_extensionsobjectReturns object
objectstringgmb_location_details
account_idstringlocation_idstring | nullflagsobject | nulllocationobjectupdate_maskarray of string | nullvalidate_onlybooleanwarningsarray of stringResponses
GBP attributes
Get Google Business attributes
/accounts/{accountId}/gmb-attributesTry it with MCPAsk your agent to call get-gmb-attributes (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
Returns object
objectstringgmb_attributes
account_idstringlocation_idstring | nullattributesarray of objectattribute_maskarray of string | nullResponses
Update Google Business attributes
/accounts/{accountId}/gmb-attributesattribute_mask defaults to the given attribute names; masked names missing from attributes are cleared.
Try it with MCPAsk your agent to call update-gmb-attributes (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Body object
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
attributesarray of objectrequired≤ 500 items
Show 4 item attributes
namestringrequired≥ 1 characters
valuesarray of anyrepeated_enum_valueobjecturi_valuesarray of anyattribute_maskstring | array of stringReturns object
objectstringgmb_attributes
account_idstringlocation_idstring | nullattributesarray of objectattribute_maskarray of string | nullResponses
GBP attribute metadata
Get Google Business attribute metadata
/accounts/{accountId}/gmb-attribute-metadataAttributes available for the location, or for a category (category_name + region_code).
Try it with MCPAsk your agent to call get-gmb-attribute-metadata (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
category_namestring≤ 300 characters
region_codestring≤ 8 characters
language_codestring≤ 35 characters
show_allbooleanlimitinteger1–200
cursorstring≤ 2048 characters
Returns object
objectstringrequiredlist
account_idstringlocation_idstring | nulldataarray of objectrequiredhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
GBP services
Get Google Business services
/accounts/{accountId}/gmb-servicesTry it with MCPAsk your agent to call get-gmb-services (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
Returns object
objectstringgmb_services
account_idstringlocation_idstring | nullservicesarray of objectcategoriesobject | nullResponses
Replace Google Business services
/accounts/{accountId}/gmb-servicesTry it with MCPAsk your agent to call replace-gmb-services (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Body object
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
service_itemsarray of objectrequired≤ 500 items
Returns object
objectstringgmb_services
account_idstringlocation_idstring | nullservicesarray of objectcategoriesobject | nullResponses
GBP food menus
Get Google Business food menus
/accounts/{accountId}/gmb-food-menusTry it with MCPAsk your agent to call get-gmb-food-menus (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
Returns object
objectstringgmb_food_menus
account_idstringlocation_idstring | nullnamestring | nullmenusarray of objectResponses
Update Google Business food menus
/accounts/{accountId}/gmb-food-menusTry it with MCPAsk your agent to call update-gmb-food-menus (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Body object
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
menusarray of objectrequiredupdate_maskstring≤ 500 characters
Returns object
objectstringgmb_food_menus
account_idstringlocation_idstring | nullnamestring | nullmenusarray of objectResponses
GBP media
List Google Business photos and videos
/accounts/{accountId}/gmb-mediaTry it with MCPAsk your agent to call list-gmb-media (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
limitinteger1–100
cursorstring≤ 2048 characters
Returns object
objectstringrequiredlist
account_idstringlocation_idstring | nulltotalinteger | nulldataarray of objectrequiredShow 14 item attributes
objectstringgmb_media
idstringnamestring | nullmedia_formatstring | nullsource_urlstring | nullgoogle_urlstring | nullthumbnail_urlstring | nulldescriptionstring | nullcreate_timestring | nulllocation_associationobject | nulldimensionsobject | nullinsightsobject | nullattributionobject | nullwarningsarray of stringhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Upload a Google Business photo or video
/accounts/{accountId}/gmb-mediaUpload by public URL (photos 10 KB–5 MB, ≥250 px; videos ≤30 s, ≤75 MB).
Try it with MCPAsk your agent to call upload-gmb-media (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
source_urlstringrequired8–4096 characters · pattern ^https?://
media_formatstringPHOTOVIDEO
categorystringCATEGORY_UNSPECIFIEDCOVERPROFILELOGOEXTERIORINTERIORPRODUCTAT_WORKFOOD_AND_DRINKMENUCOMMON_AREAROOMSTEAMSADDITIONAL
descriptionstring≤ 1000 characters
Returns object
objectstringgmb_media
idstringnamestring | nullmedia_formatstring | nullsource_urlstring | nullgoogle_urlstring | nullthumbnail_urlstring | nulldescriptionstring | nullcreate_timestring | nulllocation_associationobject | nulldimensionsobject | nullinsightsobject | nullattributionobject | nullwarningsarray of stringResponses
Delete a Google Business photo or video
/accounts/{accountId}/gmb-mediaTry it with MCPAsk your agent to call delete-gmb-media (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
media_idstringrequired1–500 characters
Returns object
objectstringrequiredgmb_media
idstringrequirednamestring | nulldeletedbooleanrequiredResponses
GBP place actions
List Google Business action links
/accounts/{accountId}/gmb-place-actionsTry it with MCPAsk your agent to call list-gmb-place-actions (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
limitinteger1–100
cursorstring≤ 2048 characters
filterstring≤ 500 characters
Returns object
objectstringrequiredlist
account_idstringlocation_idstring | nulldataarray of objectrequiredShow 10 item attributes
objectstringgmb_place_action_link
idstringnamestring | nulluristring | nullplace_action_typestring | nullis_preferredboolean | nullis_editableboolean | nullprovider_typestring | nullcreate_timestring | nullupdate_timestring | nullhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Create a Google Business action link
/accounts/{accountId}/gmb-place-actionsTry it with MCPAsk your agent to call create-gmb-place-action (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
uristringrequired8–4096 characters · pattern ^https?://
place_action_typestringrequiredAPPOINTMENTONLINE_APPOINTMENTDINING_RESERVATIONFOOD_ORDERINGFOOD_DELIVERYFOOD_TAKEOUTSHOP_ONLINESOLOPRENEUR_APPOINTMENT
is_preferredbooleanReturns object
objectstringgmb_place_action_link
idstringnamestring | nulluristring | nullplace_action_typestring | nullis_preferredboolean | nullis_editableboolean | nullprovider_typestring | nullcreate_timestring | nullupdate_timestring | nullResponses
Update a Google Business action link
/accounts/{accountId}/gmb-place-actionsTry it with MCPAsk your agent to call update-gmb-place-action (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Body object
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
namestringrequired1–500 characters
uristring8–4096 characters · pattern ^https?://
place_action_typestringAPPOINTMENTONLINE_APPOINTMENTDINING_RESERVATIONFOOD_ORDERINGFOOD_DELIVERYFOOD_TAKEOUTSHOP_ONLINESOLOPRENEUR_APPOINTMENT
is_preferredbooleanReturns object
objectstringgmb_place_action_link
idstringnamestring | nulluristring | nullplace_action_typestring | nullis_preferredboolean | nullis_editableboolean | nullprovider_typestring | nullcreate_timestring | nullupdate_timestring | nullResponses
Delete a Google Business action link
/accounts/{accountId}/gmb-place-actionsTry it with MCPAsk your agent to call delete-gmb-place-action (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
namestringrequired1–500 characters
Returns object
objectstringrequiredgmb_place_action_link
idstringrequirednamestring | nulldeletedbooleanrequiredResponses
GBP verifications
Get Google Business verification state
/accounts/{accountId}/gmb-verificationsVoice of Merchant state, a summary (live, needs_verification, …) and the verifications of the location.
Try it with MCPAsk your agent to call get-gmb-verifications (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
Returns object
objectstringgmb_verification_state
account_idstringlocation_idstring | nullsummaryobjectShow 3 child attributes
statusstringcan_editbooleanmessagestring | nullvoice_of_merchant_stateobjectverificationsarray of objectResponses
Start a Google Business verification
/accounts/{accountId}/gmb-verificationsTry it with MCPAsk your agent to call start-gmb-verification (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
methodstringrequiredADDRESSEMAILPHONE_CALLSMSAUTOTRUSTED_PARTNERVETTED_PARTNER
language_codestring≤ 35 characters
phone_numberstring≤ 40 characters
email_addressstring≤ 320 characters
mailer_contactobjectcontextobjecttrusted_partner_tokenstring≤ 2000 characters
Returns object
objectstringgmb_verification
account_idstringlocation_idstring | nullverificationobject | nullResponses
Fetch Google Business verification options
/accounts/{accountId}/gmb-verifications/optionsTry it with MCPAsk your agent to call fetch-gmb-verification-options (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Body object
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
language_codestringrequired2–35 characters
contextobjectReturns object
objectstringgmb_verification_options
account_idstringlocation_idstring | nulloptionsarray of objectResponses
Complete a Google Business verification
/accounts/{accountId}/gmb-verifications/{verificationId}/completeTry it with MCPAsk your agent to call complete-gmb-verification (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
verificationIdstringrequired1–512 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
location_idstringAct on another location of the same Google login: locations/{id}, accounts/{a}/locations/{l} or a bare id
1–300 characters
pinstringrequired1–20 characters
Returns object
objectstringgmb_verification
account_idstringlocation_idstring | nullverificationobject | nullResponses
GBP locations
List Google Business locations of the login
/accounts/{accountId}/gmb-locationsEvery location the connected Google login manages (location picker), with the Socialit account already connected to each.
Try it with MCPAsk your agent to call list-gmb-locations (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
searchstring≤ 200 characters
filterstring≤ 500 characters
limitintegerdefault: 1001–500
google_account_idstring≤ 300 characters
Returns object
objectstringrequiredlist
account_idstringselected_location_idstring | nulldataarray of objectrequiredShow 28 item attributes
objectstringgmb_location
idstringlocation_idstring | nullexternal_idstring | nullnamestring | nulltitlestring | nullgoogle_account_idstring | nullgoogle_account_namestring | nullgoogle_account_typestring | nulladdressstring | nullcategorystring | nullstore_codestring | nullphonestring | nullwebsite_uristring | nullopen_statusstring | nulllabelsarray of string | nullplace_idstring | nullmaps_uristring | nullreview_urlstring | nullis_verifiedboolean | nullhas_pending_editsboolean | nullhas_google_updatedboolean | nullcan_have_food_menusboolean | nullcan_operate_lodging_databoolean | nullcan_operate_local_postboolean | nullcan_modify_service_listboolean | nullduplicate_locationstring | object | nullconnected_account_idstring | nullhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Switch the Google Business location
/accounts/{accountId}/gmb-locationsPoint this account at another location of the same Google login. Emits account.updated.
Try it with MCPAsk your agent to call select-gmb-location (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Body object
selected_location_idstringrequired1–300 characters
google_account_idstring≤ 300 characters
Returns object
objectstringgmb_location_selection
account_idstringmessagestringselected_locationobjectShow 28 child attributes
objectstringgmb_location
idstringlocation_idstring | nullexternal_idstring | nullnamestring | nulltitlestring | nullgoogle_account_idstring | nullgoogle_account_namestring | nullgoogle_account_typestring | nulladdressstring | nullcategorystring | nullstore_codestring | nullphonestring | nullwebsite_uristring | nullopen_statusstring | nulllabelsarray of string | nullplace_idstring | nullmaps_uristring | nullreview_urlstring | nullis_verifiedboolean | nullhas_pending_editsboolean | nullhas_google_updatedboolean | nullcan_have_food_menusboolean | nullcan_operate_lodging_databoolean | nullcan_operate_local_postboolean | nullcan_modify_service_listboolean | nullduplicate_locationstring | object | nullconnected_account_idstring | nullResponses
Assign a Google Business location to a profile
/accounts/{accountId}/gmb-locations/assignConnect another location of the same Google login as a new account in profile_id (201), or move it there when it is already connected in this workspace (200). Counts toward the plan account allowance. Emits account.connected / account.updated.
Try it with MCPAsk your agent to call assign-gmb-location (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
profile_idstringrequired1–80 characters
selected_location_idstringrequired1–300 characters
google_account_idstring≤ 300 characters
Returns object
objectstringgmb_location_assignment
messagestringprofile_idstringselected_location_idstring | nullaccountobjectShow 25 child attributes
objectstringaccount
idstringplatformstringconnect_flowstringaccount_typestringprofile_idstring | nullgroup_idsarray of stringexternal_idstringparent_external_idstring | nullusernamestring | nullnamestring | nulldisplay_namestring | nullavatar_urlstring | nullprofile_urlstring | nullstatusstringis_activebooleanneeds_reconnectbooleanscopesarray of stringtoken_expires_atstring | nulldefault_configobjectmetadataobjectfollowers_countinteger | nullfollowers_updated_atstring | nullcreated_atstring | nullupdated_atstring | nullResponses
Facebook page
List Facebook Pages of the connection
/accounts/{accountId}/facebook-pagePages the connecting Facebook user granted, with the selected one and per-Page capabilities.
Try it with MCPAsk your agent to call list-facebook-pages (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
refreshbooleanReturns object
objectstringrequiredlist
account_idstringselected_page_idstring | nulltruncatedbooleandataarray of objectrequiredShow 10 item attributes
objectstringfacebook_page
idstringnamestring | nullusernamestring | nullcategorystring | nullpicturestring | nulltasksarray of stringcan_publishbooleancan_messagebooleancan_analyzebooleanhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Switch the Facebook Page
/accounts/{accountId}/facebook-pagePoint this account at another Page the user manages (stores the Page token). Emits account.updated.
Try it with MCPAsk your agent to call select-facebook-page (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Body object
selected_page_idstringrequired1–64 characters
Returns object
objectstringfacebook_page_selection
account_idstringmessagestringprevious_page_idstring | nullselected_pageobjectShow 2 child attributes
idstringnamestring | nullResponses
Webhook subscription
Read the Facebook Page's webhook subscription
/accounts/{accountId}/webhook-subscriptionWhether Socialit is subscribed to the Page (real-time comments, messages, leads) and which fields are missing.
Try it with MCPAsk your agent to call get-facebook-webhook-subscription (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Returns object
objectstringfacebook_webhook_subscription
account_idstringpage_idstringapp_subscribedbooleansubscribed_fieldsarray of stringmissing_fieldsarray of stringleadgenbooleanappsarray of objectShow 2 item attributes
idstringnamestring | nullwarningstring | nullresubscribedboolean | nullResponses
Re-subscribe the Facebook Page to Socialit webhooks
/accounts/{accountId}/webhook-subscriptionTry it with MCPAsk your agent to call resubscribe-facebook-webhooks (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object | null
fieldsarray of string≤ 50 items
Returns object
objectstringfacebook_webhook_subscription
account_idstringpage_idstringapp_subscribedbooleansubscribed_fieldsarray of stringmissing_fieldsarray of stringleadgenbooleanappsarray of objectShow 2 item attributes
idstringnamestring | nullwarningstring | nullresubscribedboolean | nullResponses
Business partners
List partner businesses of the Page
/accounts/{accountId}/business-partnersTry it with MCPAsk your agent to call list-facebook-business-partners (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Returns object
objectstringrequiredlist
account_idstringpageobject | nullShow 3 child attributes
idstringnamestring | nullbusinessobject | nullShow 2 child attributes
idstringnamestring | nulldataarray of objectrequiredShow 4 item attributes
objectstringfacebook_business_partner
idstringnamestring | nullpermitted_tasksarray of string | nullhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Share the Page with a partner business
/accounts/{accountId}/business-partnersGrant a partner Business Manager tasks on the Page (default ADVERTISE + ANALYZE).
Try it with MCPAsk your agent to call share-facebook-page-with-partner (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
business_idstringrequiredpattern ^[0-9]{1,32}$
permitted_tasksarray of string1–40 items
Returns object
objectstringfacebook_business_partner_share
account_idstringpageobject | nullShow 3 child attributes
idstringnamestring | nullbusinessobject | nullShow 2 child attributes
idstringnamestring | nullpartnerobjectShow 2 child attributes
idstringpermitted_tasksarray of stringalready_sharedbooleanResponses
Revoke a partner business from the Page
/accounts/{accountId}/business-partnersTry it with MCPAsk your agent to call revoke-facebook-business-partner (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
business_idstringrequiredpattern ^[0-9]{1,32}$
Returns object
objectstringrequiredfacebook_business_partner
idstringrequiredpage_idstring | nulldeletedbooleanrequiredResponses
LinkedIn organizations
List LinkedIn organizations
/accounts/{accountId}/linkedin-organizationsOrganizations (Pages) the member has a role on, with posting/admin rights.
Try it with MCPAsk your agent to call list-linkedin-organizations (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Returns object
objectstringrequiredlist
account_idstringdataarray of objectrequiredShow 10 item attributes
objectstringlinkedin_organization
idstringurnstringnamestring | nulllocalized_namestring | nullvanity_namestring | nulllogo_urlstring | nullrolesarray of stringcan_postbooleanis_adminbooleanhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
LinkedIn organization
Switch LinkedIn account type
/accounts/{accountId}/linkedin-organizationPost as the personal profile or as an organization the member administers. Emits account.updated.
Try it with MCPAsk your agent to call switch-linkedin-account-type (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Body object
account_typestringrequiredpersonalorganization
selected_organizationstring | objectOne of 2 shapes
Option 1 string
Option 2 object
idstring | integerurnstringReturns object
objectstringlinkedin_account_type
account_idstringaccount_typestringaccount_namestring | nullmessagestringResponses
LinkedIn mentions
Resolve a LinkedIn mention
/accounts/{accountId}/linkedin-mentionsTurn a linkedin.com profile/company URL (or URN) into a mention (@[Name](urn)) for post content.
Try it with MCPAsk your agent to call resolve-linkedin-mention (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
urlstringrequired3–2000 characters
display_namestring≤ 200 characters
organization_urnstring≤ 200 characters
Returns object
objectstringlinkedin_mention
urnstringtypestringdisplay_namestring | nullmention_formatstring | nullvanity_namestring | nullwarningstring | nullResponses
List active Instagram stories
/accounts/{accountId}/instagram/storiesTry it with MCPAsk your agent to call list-instagram-stories (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
limitinteger1–100
cursorstring≤ 2048 characters
Returns object
objectstringrequiredlist
account_idstringdataarray of objectrequiredShow 8 item attributes
objectstringinstagram_story
idstringmedia_typestring | nullmedia_product_typestring | nullmedia_urlstring | nullthumbnail_urlstring | nullpermalinkstring | nulltimestampstring | nullhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Get Instagram story insights
/accounts/{accountId}/instagram/stories/{storyId}/insightsMetrics of a live story (24 h). source: unavailable with reason when Instagram no longer serves them.
Try it with MCPAsk your agent to call get-instagram-story-insights (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
storyIdstringrequired1–128 characters
Returns object
objectstringinstagram_story_insights
story_idstringsourcestringreasonstring | nullviewsintegerreachintegerrepliesintegersharesintegerprofile_visitsintegerfollowsintegertotal_interactionsintegernavigationintegertaps_forwardintegertaps_backintegerexitsintegerswipes_forwardintegerResponses
Get Instagram publishing limit
/accounts/{accountId}/instagram/publishing-limitRolling 24 h content publishing quota (usage, total, remaining).
Try it with MCPAsk your agent to call get-instagram-publishing-limit (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Returns object
objectstringinstagram_publishing_limit
account_idstringquota_usageintegerquota_totalintegerquota_duration_secondsintegerremainingintegerResponses
Search Instagram audio
/accounts/{accountId}/instagram/audioReels audio search (trending when q is omitted). Needs a Facebook-Login Instagram connection.
Try it with MCPAsk your agent to call search-instagram-audio (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
audio_typestringdefault: "music"musicoriginal_sound
qstring≤ 200 characters
limitinteger1–100
cursorstring≤ 2048 characters
Returns object
objectstringrequiredlist
account_idstringdataarray of objectrequiredShow 12 item attributes
objectstringinstagram_audio
audio_idstringtitlestring | nullduration_in_msinteger | nullaudio_typestring | nulldisplay_artiststring | nullig_usernamestring | nullprofile_picture_urlstring | nulldownload_urlstring | nullpreview_urlstring | nullcover_artwork_urlstring | nullis_ads_eligibleboolean | nullhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Get Instagram audio metadata
/accounts/{accountId}/instagram/audio/{audioId}Re-validates a track and refreshes its preview URL (expires after ~1.5 days).
Try it with MCPAsk your agent to call get-instagram-audio (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
audioIdstringrequired1–128 characters
Returns object
objectstringinstagram_audio
audio_idstringtitlestring | nullduration_in_msinteger | nullaudio_typestring | nulldisplay_artiststring | nullig_usernamestring | nullprofile_picture_urlstring | nulldownload_urlstring | nullpreview_urlstring | nullcover_artwork_urlstring | nullis_ads_eligibleboolean | nullResponses
Look up a public Instagram Business account
/accounts/{accountId}/instagram/business-discoveryPublic profile and recent media of another Business/Creator account (competitor research).
Try it with MCPAsk your agent to call instagram-business-discovery (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
usernamestringrequiredpattern ^@?[A-Za-z0-9._]{1,30}$
limitintegerdefault: 121–50
cursorstring≤ 2048 characters
Returns object
objectstringinstagram_business_discovery
profileobjectShow 10 child attributes
idstringig_idinteger | string | nullusernamestring | nullnamestring | nullbiographystring | nullwebsitestring | nullprofile_picture_urlstring | nullfollowers_countinteger | nullfollows_countinteger | nullmedia_countinteger | nullmediaarray of objectnext_cursorstring | nullResponses
Follow status
Check whether an Instagram user follows the account
/accounts/{accountId}/follow-status/{userId}Follow relationship for an Instagram-scoped user id (IGSID). Meta only answers for users who messaged the account; otherwise unavailable_reason is set.
Try it with MCPAsk your agent to call get-instagram-follow-status (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
userIdstringrequired1–128 characters
Query parameters
refreshbooleanReturns object
objectstringinstagram_follow_status
account_idstringuser_idstringis_followerboolean | nullis_followed_by_accountboolean | nullfollower_countinteger | nullis_verifiedboolean | nullusernamestring | nullnamestring | nullunavailable_reasonstring | nullResponses
Pinterest boards
List Pinterest boards
/accounts/{accountId}/pinterest-boardsEvery board of the Pinterest account plus the stored default board.
Try it with MCPAsk your agent to call list-pinterest-boards (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Returns object
objectstringrequiredlist
account_idstringdefault_board_idstring | nulldefault_board_namestring | nulldataarray of objectrequiredShow 14 item attributes
objectstringpinterest_board
idstringnamestring | nulldescriptionstring | nullprivacystring | nullurlstring | nullpin_countinteger | nullfollower_countinteger | nullcollaborator_countinteger | nullis_ads_onlyboolean | nullimage_cover_urlstring | nullowner_usernamestring | nullcreated_atstring | nullboard_pins_modified_atstring | nullhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Create a Pinterest board
/accounts/{accountId}/pinterest-boardsSECRET boards need the boards:write_secret scope.
Try it with MCPAsk your agent to call create-pinterest-board (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
namestringrequired1–180 characters
descriptionstring≤ 500 characters
privacystringPUBLICPROTECTEDSECRET
Returns object
objectstringpinterest_board
idstringnamestring | nulldescriptionstring | nullprivacystring | nullurlstring | nullpin_countinteger | nullfollower_countinteger | nullcollaborator_countinteger | nullis_ads_onlyboolean | nullimage_cover_urlstring | nullowner_usernamestring | nullcreated_atstring | nullboard_pins_modified_atstring | nullResponses
Set the default Pinterest board
/accounts/{accountId}/pinterest-boardsUsed when a post does not name a board. Emits account.updated.
Try it with MCPAsk your agent to call set-default-pinterest-board (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Body object
default_board_idstringrequired1–64 characters
default_board_namestring≤ 180 characters
Returns object
objectstringpinterest_default_board
account_idstringdefault_board_idstringdefault_board_namestring | nullmessagestringResponses
YouTube playlists
List YouTube playlists
/accounts/{accountId}/youtube-playlistsEvery playlist of the channel plus the stored default playlist.
Try it with MCPAsk your agent to call list-youtube-playlists (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Returns object
objectstringrequiredlist
account_idstringdefault_playlist_idstring | nulldefault_playlist_namestring | nulldataarray of objectrequiredShow 9 item attributes
objectstringyoutube_playlist
idstringtitlestring | nulldescriptionstring | nullprivacystring | nullitem_countinteger | nullthumbnail_urlstring | nullpublished_atstring | nullurlstring | nullhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Create a YouTube playlist
/accounts/{accountId}/youtube-playlistsCosts 50 quota units; not idempotent upstream (list before retrying).
Try it with MCPAsk your agent to call create-youtube-playlist (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
titlestringrequired1–150 characters
descriptionstring≤ 5000 characters
privacystringdefault: "private"privatepublicunlisted
default_languagestring≤ 35 characters
Returns object
objectstringyoutube_playlist
idstringtitlestring | nulldescriptionstring | nullprivacystring | nullitem_countinteger | nullthumbnail_urlstring | nullpublished_atstring | nullurlstring | nullResponses
Set the default YouTube playlist
/accounts/{accountId}/youtube-playlistsPre-fills the composer playlist. Emits account.updated.
Try it with MCPAsk your agent to call set-default-youtube-playlist (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Body object
default_playlist_idstringrequired1–64 characters
default_playlist_namestring≤ 150 characters
Returns object
objectstringyoutube_default_playlist
account_idstringdefault_playlist_idstringdefault_playlist_namestring | nullResponses
YouTube captions
Get a YouTube video transcript
/accounts/{accountId}/youtube-captionsCaption track of a video on the channel as text + timed cues (optionally SRT/VTT, or translated with tlang).
Try it with MCPAsk your agent to call get-youtube-transcript (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
video_idstringrequired1–64 characters
languagestring≤ 35 characters
formatstringdefault: "json"jsonsrtvtt
track_idstring≤ 200 characters
tlangstring≤ 35 characters
refreshbooleanReturns object
objectstringyoutube_transcript
account_idstringvideo_idstringlanguagestring | nulltrack_idstring | nulltrack_kindstring | nullsourcestringfetched_atstring | nulltextstring | nullcuesarray of objectShow 3 item attributes
startnumber | nullendnumber | nulltextstring | nullsrtstring | nullvttstring | nullavailable_tracksarray of objectResponses
Reddit subreddits
List Reddit subreddits
/accounts/{accountId}/reddit-subredditsSubreddits the user can post to (subscriber/contributor/moderator, plus the user profile) and the default subreddit.
Try it with MCPAsk your agent to call list-reddit-subreddits (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
wherestringdefault: "postable"postablesubscribermoderatorcontributor
limitinteger1–100
cursorstring≤ 200 characters
Returns object
objectstringrequiredlist
account_idstringdefault_subredditstring | nulldataarray of objectrequiredShow 16 item attributes
objectstringreddit_subreddit
idstring | nullnamestring | nullprefixed_namestring | nulltitlestring | nulldescriptionstring | nullsubscribersinteger | nullactive_usersinteger | nulltypestring | nullover_18boolean | nullquarantinedboolean | nullsubmission_typestring | nullpost_typesobjectuser_is_moderatorboolean | nulluser_is_contributorboolean | nulluser_is_subscriberboolean | nullhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Set the default subreddit
/accounts/{accountId}/reddit-subredditsValidates the subreddit exists. Emits account.updated.
Try it with MCPAsk your agent to call set-default-reddit-subreddit (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Body object
default_subredditstringrequired1–64 characters
Returns object
objectstringreddit_default_subreddit
account_idstringdefault_subredditstringResponses
Get subreddit rules
/accounts/{accountId}/reddit-subreddits/{subreddit}/rulesTry it with MCPAsk your agent to call get-reddit-subreddit-rules (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
subredditstringrequired1–64 characters
Returns object
objectstringreddit_subreddit_rules
subredditstringrulesarray of objectShow 7 item attributes
idstring | nullpriorityinteger | nullshort_namestring | nulldescriptionstring | nullviolation_reasonstring | nullkindstring | nullcreated_atstring | nullsite_rulesarray of stringsite_rules_flowarray of objectResponses
Reddit flairs
List subreddit post flairs
/accounts/{accountId}/reddit-flairsrestricted: true when the user cannot set link flair in that subreddit.
Try it with MCPAsk your agent to call list-reddit-flairs (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
subredditstringrequired1–64 characters
Returns object
objectstringrequiredlist
account_idstringsubredditstringrestrictedbooleandataarray of objectrequiredShow 12 item attributes
objectstringreddit_flair
idstringtextstring | nulltext_colorstring | nullbackground_colorstring | nulltext_editablebooleantypestring | nullrichtextarray of anymod_onlybooleanallowable_contentstring | nullmax_emojisinteger | nullcss_classstring | nullhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Set a Reddit post flair
/accounts/{accountId}/reddit-flairsTry it with MCPAsk your agent to call set-reddit-post-flair (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
subredditstring1–64 characters
post_idstringrequired1–32 characters
flair_template_idstringrequired1–64 characters
textstring≤ 64 characters
Returns object
objectstringreddit_post_flair
account_idstringpost_idstringflair_template_idstringtextstring | nullsuccessbooleanResponses
Reddit vote
Vote on a Reddit post or comment
/accounts/{accountId}/reddit-voteOne vote per call, triggered by an explicit human action (automated or bulk voting violates Reddit rules).
Try it with MCPAsk your agent to call vote-on-reddit (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
thing_idstringrequired2–32 characters
directionintegerrequired10-1
Returns object
objectstringreddit_vote
account_idstringthing_idstringdirectionintegersuccessbooleanResponses
TikTok
Get TikTok creator info
/accounts/{accountId}/tiktok/creator-infoLatest creator_info for the Post-to-TikTok UX: privacy options, interaction locks, max duration, whether the creator can post now.
Try it with MCPAsk your agent to call get-tiktok-creator-info (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
media_typestringdefault: "video"videophoto
Returns object
objectstringtiktok_creator_info
account_idstringlanestringcreatorobjectShow 6 child attributes
nicknamestring | nullusernamestring | nullavatar_urlstring | nullis_verifiedboolean | nullcan_post_morebooleanreasonstring | number | nullprivacy_levelsarray of objectShow 2 item attributes
valuestringlabelstring | nullposting_limitsobjectShow 2 child attributes
max_video_duration_secinteger | nullinteraction_settingsobjectShow 3 child attributes
allow_commentobject | nullShow 4 child attributes
enabledbooleanrequiredbooleandefaultbooleanlabelstring | nullallow_duetobject | nullShow 4 child attributes
enabledbooleanrequiredbooleandefaultbooleanlabelstring | nullallow_stitchobject | nullShow 4 child attributes
enabledbooleanrequiredbooleandefaultbooleanlabelstring | nullcommercial_content_typesarray of objectShow 3 item attributes
valuestringlabelstring | nullrequiresstring | nullwarningstring | nullResponses
Get TikTok composer requirements
/accounts/{accountId}/tiktok/composerEverything a "Post to TikTok" UI must render under the Content Sharing Guidelines, from live creator_info: creator nickname/avatar, privacy options (no default), interaction toggles (off by default, locked when the creator disabled them), commercial content disclosure, the exact declaration text, notices and limits. Re-fetch on every composer render.
Try it with MCPAsk your agent to call get-tiktok-composer-requirements (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
media_typestringdefault: "video"videophoto
Returns object
objectstringtiktok_composer_requirements
account_idstringlanestringmedia_typestringfetched_atstringcreatorobjectShow 9 child attributes
nicknamestring | nullusernamestring | nullavatar_urlstring | nullavatar_ttl_secondsinteger | nullmust_displayarray of stringcan_postbooleancannot_post_reasonstring | number | nullcannot_post_messagestring | nullwarningstring | nullprivacyobjectShow 5 child attributes
optionsarray of objectShow 3 item attributes
valuestringlabelstringallowed_with_branded_contentbooleandefaultstring | nullrequiredbooleancontrolstringdirect_post_forcedstring | nullinteractionsobjectShow 3 child attributes
commentobject | nullShow 5 child attributes
labelstringavailablebooleandisabled_by_creatorbooleandefaultbooleanrequired_user_actionbooleanduetobject | nullShow 5 child attributes
labelstringavailablebooleandisabled_by_creatorbooleandefaultbooleanrequired_user_actionbooleanstitchobject | nullShow 5 child attributes
labelstringavailablebooleandisabled_by_creatorbooleandefaultbooleanrequired_user_actionbooleanmax_video_duration_secinteger | nullcommercial_contentobjectShow 6 child attributes
toggleobjectShow 2 child attributes
labelstringdefaultbooleanoptionsarray of objectShow 7 item attributes
valuestringlabelstringmaps_tostringnoticestring | nulldefaultbooleandisallowed_privacyarray of stringdisallowed_privacy_tooltipstringmulti_selectbooleanboth_selected_noticestring | nullselection_required_when_onbooleanpublish_disabled_tooltipstringdeclarationobjectShow 5 child attributes
positionstringdefaultstringyour_brand_onlystringbranded_contentstringlinksobjectShow 2 child attributes
musicUsageConfirmationstringbrandedContentPolicystringnoticesobjectShow 2 child attributes
processingstringdraftstringrulesmap of booleanlimitsobjectShow 7 child attributes
title_maxinteger | nulldescription_maxinteger | nullphotos_maxinteger | nullformatsarray of stringmax_bytesinteger | nullposts_per_dayinteger | nullpending_draftsinteger | nullfeaturesmap of booleanResponses
List trending TikTok commercial music
/accounts/{accountId}/tiktok/commercial-musicCommercial Music Library tracks (TikTok Business connections).
Try it with MCPAsk your agent to call list-tiktok-commercial-music (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
country_codestringpattern ^[A-Za-z]{2}$
genrestring≤ 64 characters
date_rangestring1DAY7DAY30DAY90DAY
Returns object
objectstringrequiredlist
account_idstringdataarray of objectrequiredShow 12 item attributes
objectstringtiktok_music_track
idstring | nullcommercial_music_idstring | nullnamestring | nullartiststring | nullduration_secnumber | nullgenresarray of stringpreview_urlstring | nullthumbnail_urlstring | nullrankinteger | nulltrending_historyarray of objectclipobject | nullShow 3 child attributes
idstring | nullduration_secnumber | nullpreview_urlstring | nullhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Search TikTok location tags
/accounts/{accountId}/tiktok/locationsUp to 20 location tags for posts (TikTok Business connections).
Try it with MCPAsk your agent to call search-tiktok-locations (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
querystringrequired1–100 characters
Returns object
objectstringrequiredlist
account_idstringdataarray of objectrequiredShow 4 item attributes
objectstringtiktok_location
idstring | nullnamestring | nulladdressstring | nullhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Bluesky settings
Get Bluesky account settings
/accounts/{accountId}/bluesky-settingsPosting defaults applied to every new Bluesky post (languages, reply/quote controls, labels, tags, auto facets/link cards).
Try it with MCPAsk your agent to call get-bluesky-settings (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Returns object
objectstringbluesky_settings
account_idstringdefault_langsarray of string | nulldefault_threadgatearray of string | nulldefault_postgateobject | nullShow 1 child attributes
disable_quotesbooleandefault_labelsarray of stringdefault_tagsarray of stringauto_facetsbooleanauto_link_cardsbooleanResponses
Update Bluesky account settings
/accounts/{accountId}/bluesky-settingsPartial update; only affects posts published afterwards. Emits account.updated.
Try it with MCPAsk your agent to call update-bluesky-settings (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Body object
default_langsarray of string | null≤ 3 items
default_threadgatearray of string | null≤ 5 items
default_postgateobject | nullShow 1 child attributes
disable_quotesbooleandefault_labelsarray of string≤ 4 items
default_tagsarray of string≤ 8 items
auto_facetsbooleanauto_link_cardsbooleanReturns object
objectstringbluesky_settings
account_idstringdefault_langsarray of string | nulldefault_threadgatearray of string | nulldefault_postgateobject | nullShow 1 child attributes
disable_quotesbooleandefault_labelsarray of stringdefault_tagsarray of stringauto_facetsbooleanauto_link_cardsbooleanResponses
Discord settings
Get Discord account settings
/accounts/{accountId}/discord-settingsTry it with MCPAsk your agent to call get-discord-settings (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Returns object
objectstringdiscord_settings
account_idstringmodestringguild_idstring | nullguild_namestring | nullchannel_idstring | nullchannel_namestring | nullchannel_typeinteger | string | nullwebhook_usernamestring | nullwebhook_avatar_urlstring | nullResponses
Update Discord account settings
/accounts/{accountId}/discord-settingsWebhook identity (username / avatar; empty clears) or, for bot connections, the posting channel in the same server. Emits account.updated.
Try it with MCPAsk your agent to call update-discord-settings (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Body object
webhook_usernamestring | null≤ 80 characters
webhook_avatar_urlstring | null≤ 2048 characters
channel_idstringpattern ^[0-9]{5,25}$
Returns object
objectstringdiscord_settings
account_idstringmodestringguild_idstring | nullguild_namestring | nullchannel_idstring | nullchannel_namestring | nullchannel_typeinteger | string | nullwebhook_usernamestring | nullwebhook_avatar_urlstring | nullResponses
Discord channels
List Discord server channels
/accounts/{accountId}/discord-channelsTry it with MCPAsk your agent to call list-discord-channels (toolset platform_tools)Set up MCP
Path parameters
accountIdstringrequiredSocial account id (sa_…)
1–80 characters
Query parameters
typesstringpattern ^[0-9]+(,[0-9]+)*$
Returns object
objectstringrequiredlist
account_idstringdataarray of objectrequiredShow 10 item attributes
objectstringdiscord_channel
idstringnamestring | nulltypeintegertype_namestring | nullparent_idstring | nullpositionintegertopicstring | nullnsfwbooleanpostablebooleanhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Discord
Send a Discord direct message
/discord/dmsDM a server member from the Socialit bot. Runs on the Socialit Discord bot; account_id must be a bot-mode Discord account connected to that server.
Try it with MCPAsk your agent to call send-discord-dm (toolset platform_tools)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
account_idstringrequiredSocial account id (sa_…)
1–80 characters
user_idstringrequiredpattern ^[0-9]{5,25}$
contentstring≤ 2000 characters
embedsarray of object≤ 10 items
attachmentsarray of object≤ 10 items
Show 5 item attributes
typestringrequiredimagevideogifdocument
urlstringrequired≤ 4096 characters · pattern ^https?://
filenamestring≤ 200 characters
mime_typestring≤ 100 characters
sizeintegerttsbooleanReturns object
objectstringdiscord_dm
account_idstringmessage_idstring | nullchannel_idstring | nullurlstring | nulltimestampstring | nullrecipientobjectShow 2 child attributes
user_idstringplatformstringResponses
List Discord server roles
/discord/guilds/{guildId}/rolesRuns on the Socialit Discord bot; account_id must be a bot-mode Discord account connected to that server.
Try it with MCPAsk your agent to call list-discord-roles (toolset platform_tools)Set up MCP
Path parameters
guildIdstringrequired1–512 characters
Query parameters
account_idstringrequiredSocial account id (sa_…)
1–80 characters
Returns object
objectstringrequiredlist
account_idstringguild_idstringdataarray of objectrequiredShow 12 item attributes
objectstringdiscord_role
idstringnamestring | nullcolorintegerpositionintegerpermissionsstring | nullpermission_namesarray of stringmanagedbooleanmentionablebooleanhoistbooleaniconstring | nullunicode_emojistring | nullhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Create a Discord server role
/discord/guilds/{guildId}/rolesRuns on the Socialit Discord bot; account_id must be a bot-mode Discord account connected to that server. Needs MANAGE_ROLES.
Try it with MCPAsk your agent to call create-discord-role (toolset platform_tools)Set up MCP
Path parameters
guildIdstringrequired1–512 characters
Query parameters
account_idstringrequiredSocial account id (sa_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
namestringrequired1–100 characters
colorinteger | stringhoistbooleanmentionablebooleanpermissionsstring | array of stringunicode_emojistring | null≤ 32 characters
reasonstring≤ 512 characters
Returns object
objectstringdiscord_role
idstringnamestring | nullcolorintegerpositionintegerpermissionsstring | nullpermission_namesarray of stringmanagedbooleanmentionablebooleanhoistbooleaniconstring | nullunicode_emojistring | nullResponses
Edit a Discord server role
/discord/guilds/{guildId}/roles/{roleId}Try it with MCPAsk your agent to call update-discord-role (toolset platform_tools)Set up MCP
Path parameters
guildIdstringrequired1–512 characters
roleIdstringrequired1–512 characters
Query parameters
account_idstringrequiredSocial account id (sa_…)
1–80 characters
Body object
namestring1–100 characters
colorinteger | stringhoistbooleanmentionablebooleanpermissionsstring | array of stringunicode_emojistring | null≤ 32 characters
reasonstring≤ 512 characters
Returns object
objectstringdiscord_role
idstringnamestring | nullcolorintegerpositionintegerpermissionsstring | nullpermission_namesarray of stringmanagedbooleanmentionablebooleanhoistbooleaniconstring | nullunicode_emojistring | nullResponses
Delete a Discord server role
/discord/guilds/{guildId}/roles/{roleId}Try it with MCPAsk your agent to call delete-discord-role (toolset platform_tools)Set up MCP
Path parameters
guildIdstringrequired1–512 characters
roleIdstringrequired1–512 characters
Query parameters
account_idstringrequiredSocial account id (sa_…)
1–80 characters
reasonstring≤ 512 characters
Returns object
objectstringrequireddiscord_role
idstringrequireddeletedbooleanrequiredResponses
List Discord server members
/discord/guilds/{guildId}/membersNeeds the privileged GUILD_MEMBERS intent; otherwise an empty list with intent_missing: true. Page with after = next_cursor.
Try it with MCPAsk your agent to call list-discord-members (toolset platform_tools)Set up MCP
Path parameters
guildIdstringrequired1–512 characters
Query parameters
account_idstringrequiredSocial account id (sa_…)
1–80 characters
limitintegerdefault: 1001–1000
afterstringpattern ^[0-9]{5,25}$
Returns object
objectstringrequiredlist
account_idstringguild_idstringintent_missingbooleandataarray of objectrequiredShow 14 item attributes
objectstringdiscord_member
idstringusernamestring | nullglobal_namestring | nullnickstring | nulldisplay_namestring | nullavatarstring | nullbotbooleanrolesarray of stringjoined_atstring | nullpremium_sincestring | nullpendingbooleancommunication_disabled_untilstring | nullflagsintegerhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Search Discord server members
/discord/guilds/{guildId}/members/searchPrefix match on username / nickname (no privileged intent needed).
Try it with MCPAsk your agent to call search-discord-members (toolset platform_tools)Set up MCP
Path parameters
guildIdstringrequired1–512 characters
Query parameters
account_idstringrequiredSocial account id (sa_…)
1–80 characters
querystringrequired1–100 characters
limitintegerdefault: 251–1000
Returns object
objectstringrequiredlist
account_idstringguild_idstringintent_missingbooleandataarray of objectrequiredShow 14 item attributes
objectstringdiscord_member
idstringusernamestring | nullglobal_namestring | nullnickstring | nulldisplay_namestring | nullavatarstring | nullbotbooleanrolesarray of stringjoined_atstring | nullpremium_sincestring | nullpendingbooleancommunication_disabled_untilstring | nullflagsintegerhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Get a Discord server member
/discord/guilds/{guildId}/members/{userId}Try it with MCPAsk your agent to call get-discord-member (toolset platform_tools)Set up MCP
Path parameters
guildIdstringrequired1–512 characters
userIdstringrequired1–512 characters
Query parameters
account_idstringrequiredSocial account id (sa_…)
1–80 characters
Returns object
objectstringdiscord_member
idstringusernamestring | nullglobal_namestring | nullnickstring | nulldisplay_namestring | nullavatarstring | nullbotbooleanrolesarray of stringjoined_atstring | nullpremium_sincestring | nullpendingbooleancommunication_disabled_untilstring | nullflagsintegerResponses
Assign a role to a Discord member
/discord/guilds/{guildId}/members/{userId}/roles/{roleId}Try it with MCPAsk your agent to call add-discord-member-role (toolset platform_tools)Set up MCP
Path parameters
guildIdstringrequired1–512 characters
userIdstringrequired1–512 characters
roleIdstringrequired1–512 characters
Query parameters
account_idstringrequiredSocial account id (sa_…)
1–80 characters
reasonstring≤ 512 characters
Returns object
objectstringdiscord_member_role
guild_idstringuser_idstringrole_idstringoperationstringResponses
Remove a role from a Discord member
/discord/guilds/{guildId}/members/{userId}/roles/{roleId}Try it with MCPAsk your agent to call remove-discord-member-role (toolset platform_tools)Set up MCP
Path parameters
guildIdstringrequired1–512 characters
userIdstringrequired1–512 characters
roleIdstringrequired1–512 characters
Query parameters
account_idstringrequiredSocial account id (sa_…)
1–80 characters
reasonstring≤ 512 characters
Returns object
objectstringdiscord_member_role
guild_idstringuser_idstringrole_idstringoperationstringResponses
Delete a Discord channel message
/discord/channels/{channelId}/messages/{messageId}Runs on the Socialit Discord bot; account_id must be a bot-mode Discord account connected to that server. Deleting other users' messages needs MANAGE_MESSAGES.
Try it with MCPAsk your agent to call delete-discord-message (toolset platform_tools)Set up MCP
Path parameters
channelIdstringrequired1–512 characters
messageIdstringrequired1–512 characters
Query parameters
account_idstringrequiredSocial account id (sa_…)
1–80 characters
reasonstring≤ 512 characters
Returns object
objectstringrequireddiscord_message
idstringrequiredchannel_idstringdeletedbooleanrequiredResponses
Crosspost a Discord announcement
/discord/channels/{channelId}/messages/{messageId}/crosspostPublish an announcement-channel message to every following server.
Try it with MCPAsk your agent to call crosspost-discord-message (toolset platform_tools)Set up MCP
Path parameters
channelIdstringrequired1–512 characters
messageIdstringrequired1–512 characters
Query parameters
account_idstringrequiredSocial account id (sa_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Returns object
objectstringdiscord_crosspost
idstringchannel_idstringmessageobjectResponses
Create a Discord public thread
/discord/channels/{channelId}/threadsFrom a message when message_id is set, otherwise a standalone thread.
Try it with MCPAsk your agent to call create-discord-thread (toolset platform_tools)Set up MCP
Path parameters
channelIdstringrequired1–512 characters
Query parameters
account_idstringrequiredSocial account id (sa_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
namestringrequired1–100 characters
message_idstringpattern ^[0-9]{5,25}$
auto_archive_durationinteger601440432010080
rate_limit_per_userinteger0–21600
reasonstring≤ 512 characters
Returns object
objectstringdiscord_thread
idstringnamestring | nullparent_idstring | nullthreadobjectResponses
List pinned Discord messages
/discord/channels/{channelId}/pinsTry it with MCPAsk your agent to call list-discord-pins (toolset platform_tools)Set up MCP
Path parameters
channelIdstringrequired1–512 characters
Query parameters
account_idstringrequiredSocial account id (sa_…)
1–80 characters
beforestring≤ 40 characters
limitintegerdefault: 501–50
Returns object
objectstringrequiredlist
account_idstringchannel_idstringdataarray of objectrequiredShow 9 item attributes
objectstringdiscord_pinned_message
idstringchannel_idstring | nullcontentstring | nulltimestampstring | nullpinned_atstring | nullauthorobjectattachmentsarray of objectembedsarray of objecthas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Pin a Discord message
/discord/channels/{channelId}/pins/{messageId}Try it with MCPAsk your agent to call pin-discord-message (toolset platform_tools)Set up MCP
Path parameters
channelIdstringrequired1–512 characters
messageIdstringrequired1–512 characters
Query parameters
account_idstringrequiredSocial account id (sa_…)
1–80 characters
reasonstring≤ 512 characters
Returns object
objectstringdiscord_pin
channel_idstringmessage_idstringpinnedbooleanResponses
Unpin a Discord message
/discord/channels/{channelId}/pins/{messageId}Try it with MCPAsk your agent to call unpin-discord-message (toolset platform_tools)Set up MCP
Path parameters
channelIdstringrequired1–512 characters
messageIdstringrequired1–512 characters
Query parameters
account_idstringrequiredSocial account id (sa_…)
1–80 characters
reasonstring≤ 512 characters
Returns object
objectstringdiscord_pin
channel_idstringmessage_idstringpinnedbooleanResponses
List Discord scheduled events
/discord/guilds/{guildId}/eventsTry it with MCPAsk your agent to call list-discord-events (toolset platform_tools)Set up MCP
Path parameters
guildIdstringrequired1–512 characters
Query parameters
account_idstringrequiredSocial account id (sa_…)
1–80 characters
with_user_countbooleandefault: trueReturns object
objectstringrequiredlist
account_idstringguild_idstringdataarray of objectrequiredShow 15 item attributes
objectstringdiscord_scheduled_event
idstringguild_idstring | nullnamestring | nulldescriptionstring | nullstarts_atstring | nullends_atstring | nullstatusstring | integerentity_typestring | integerchannel_idstring | nulllocationstring | nulluser_countinteger | nullimagestring | nullrecurrence_ruleobject | nullcreator_idstring | nullhas_morebooleanrequirednext_cursorstring | nullrequiredResponses
Create a Discord scheduled event
/discord/guilds/{guildId}/eventsExternal (location + end time), voice or stage (channel) events; always server-only privacy.
Try it with MCPAsk your agent to call create-discord-event (toolset platform_tools)Set up MCP
Path parameters
guildIdstringrequired1–512 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
account_idstringrequiredSocial account id (sa_…)
1–80 characters
namestringrequired1–100 characters
descriptionstring≤ 1000 characters
starts_atstringrequired10–40 characters
ends_atstring10–40 characters
entityobjectrequiredShow 4 child attributes
typestringrequiredexternalvoicestage
locationstring≤ 100 characters
channel_idstringpattern ^[0-9]{5,25}$
ends_atstring10–40 characters
image_data_uristring | nulldata: URI or https URL (null clears on update)
≤ 12000000 characters
recurrence_ruleobjectreasonstring≤ 512 characters
Returns object
objectstringdiscord_scheduled_event
idstringguild_idstring | nullnamestring | nulldescriptionstring | nullstarts_atstring | nullends_atstring | nullstatusstring | integerentity_typestring | integerchannel_idstring | nulllocationstring | nulluser_countinteger | nullimagestring | nullrecurrence_ruleobject | nullcreator_idstring | nullResponses
Get a Discord scheduled event
/discord/guilds/{guildId}/events/{eventId}Try it with MCPAsk your agent to call get-discord-event (toolset platform_tools)Set up MCP
Path parameters
guildIdstringrequired1–512 characters
eventIdstringrequired1–512 characters
Query parameters
account_idstringrequiredSocial account id (sa_…)
1–80 characters
with_user_countbooleandefault: trueReturns object
objectstringdiscord_scheduled_event
idstringguild_idstring | nullnamestring | nulldescriptionstring | nullstarts_atstring | nullends_atstring | nullstatusstring | integerentity_typestring | integerchannel_idstring | nulllocationstring | nulluser_countinteger | nullimagestring | nullrecurrence_ruleobject | nullcreator_idstring | nullResponses
Update a Discord scheduled event
/discord/guilds/{guildId}/events/{eventId}Try it with MCPAsk your agent to call update-discord-event (toolset platform_tools)Set up MCP
Path parameters
guildIdstringrequired1–512 characters
eventIdstringrequired1–512 characters
Body object
account_idstringrequiredSocial account id (sa_…)
1–80 characters
namestring1–100 characters
descriptionstring | null≤ 1000 characters
starts_atstring10–40 characters
ends_atstring | null≤ 40 characters
locationstring≤ 100 characters
statusstringscheduledactivecompletedcancelled
image_data_uristring | nulldata: URI or https URL (null clears on update)
≤ 12000000 characters
recurrence_ruleobject | nullreasonstring≤ 512 characters
Returns object
objectstringdiscord_scheduled_event
idstringguild_idstring | nullnamestring | nulldescriptionstring | nullstarts_atstring | nullends_atstring | nullstatusstring | integerentity_typestring | integerchannel_idstring | nulllocationstring | nulluser_countinteger | nullimagestring | nullrecurrence_ruleobject | nullcreator_idstring | nullResponses
Delete a Discord scheduled event
/discord/guilds/{guildId}/events/{eventId}Try it with MCPAsk your agent to call delete-discord-event (toolset platform_tools)Set up MCP
Path parameters
guildIdstringrequired1–512 characters
eventIdstringrequired1–512 characters
Query parameters
account_idstringrequiredSocial account id (sa_…)
1–80 characters
reasonstring≤ 512 characters
Returns object
objectstringrequireddiscord_scheduled_event
idstringrequireddeletedbooleanrequired