Network-specific API

Set or change thumbnail for a YouTube video

misc.youtube.setThumbnail · requires x-api-key

Request body application/json

• teamId string required
• url string required
• postId string required

Example

curl -X POST "https://api.siaran.my/api/v1/misc/youtube/thumbnail" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "url": "https://example.com/file.jpg",
    "postId": "POST_ID"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Get channel playlists

misc.youtube.getChannelPlaylist · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/youtube/playlist?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Create a new playlist

misc.youtube.createNewChannelPlaylist · requires x-api-key

Request body application/json

• teamId string required
• title string required
• description string required
• privacyStatus string
  One of: public unlisted private

Example

curl -X POST "https://api.siaran.my/api/v1/misc/youtube/playlist" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "title": "Hello from Siar",
    "description": "Hello from Siar"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Update an existing playlist

misc.youtube.updateChannelPlaylist · requires x-api-key

Request body application/json

• teamId string required
• title string required
• description string required
• privacyStatus string
  One of: public unlisted private
• playlistId string required

Example

curl -X PUT "https://api.siaran.my/api/v1/misc/youtube/playlist" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "title": "Hello from Siar",
    "description": "Hello from Siar",
    "playlistId": "PLAYLIST_ID"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Delete a channel playlist

misc.youtube.deleteChannelPlaylist · requires x-api-key

Parameters

Example

curl -X DELETE "https://api.siaran.my/api/v1/misc/youtube/playlist/PLAYLISTID?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

A boolean.

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Add a video to a playlist

misc.youtube.addVideoToPlaylist · requires x-api-key

Request body application/json

• teamId string required
• playlistId string required
• postId string required
• position integer ≥ 0

Example

curl -X POST "https://api.siaran.my/api/v1/misc/youtube/playlist-items" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "playlistId": "PLAYLIST_ID",
    "postId": "POST_ID"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Get videos from a playlist

misc.youtube.getVideosFromPlaylist · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/youtube/playlist-items?teamId=TEAM_ID&playlistId=PLAYLIST_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Remove a video from a playlist

misc.youtube.deleteVideoFromPlaylist · requires x-api-key

Parameters

Example

curl -X DELETE "https://api.siaran.my/api/v1/misc/youtube/playlist-items/PLAYLISTITEMID?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

A boolean.

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Edit YouTube video metadata

misc.youtube.editVideo · requires x-api-key

Request body application/json

• teamId string required
• postId string required
• title string
• description string
• tags string[]
• categoryId string
• privacyStatus string
  One of: public unlisted private
• defaultLanguage string max length 35
• defaultAudioLanguage string max length 35

Example

curl -X PATCH "https://api.siaran.my/api/v1/misc/youtube/video" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "postId": "POST_ID"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Delete a YouTube video

misc.youtube.deleteVideo · requires x-api-key

Request body application/json

• teamId string required
• postId string required

Example

curl -X DELETE "https://api.siaran.my/api/v1/misc/youtube/video" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "postId": "POST_ID"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Edit YouTube comment

misc.youtube.editComment · requires x-api-key

Request body application/json

• teamId string required
• commentId string required
• text string required min length 1

Example

curl -X PATCH "https://api.siaran.my/api/v1/misc/youtube/comment" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "commentId": "COMMENT_ID",
    "text": "Hello from Siar"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Delete a YouTube comment

misc.youtube.deleteComment · requires x-api-key

Request body application/json

• teamId string required
• commentId string required

Example

curl -X DELETE "https://api.siaran.my/api/v1/misc/youtube/comment" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "commentId": "COMMENT_ID"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Get YouTube video categories

misc.youtube.getVideoCategories · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/youtube/video-categories?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Get YouTube regions

misc.youtube.getRegions · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/youtube/regions?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Get Linkedin mentionable tags (people & organizations)

misc.linkedin.getTags · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/linkedin/mentions/tags?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Build Linkedin text, insert mentions at tag placeholders.

misc.linkedin.buildCommentary · requires x-api-key

Request body application/json

• text string default ""
• tags object[] default []
  2 fields

  • display string required
  • urn string required

Example

curl -X POST "https://api.siaran.my/api/v1/misc/linkedin/mentions/builder" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "text": "",
    "tags": []
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Reshare an existing LinkedIn post

misc.linkedin.resharePost · requires x-api-key

Request body application/json

• teamId string required
• parentPostUrn string required min length 1
• commentary string required min length 1max length 3,000
• visibility string nullable default "PUBLIC"
  One of: CONNECTIONS PUBLIC LOGGED_IN CONTAINER
• disableReshare boolean nullable default false

Example

curl -X POST "https://api.siaran.my/api/v1/misc/linkedin/post/reshare" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "parentPostUrn": "string",
    "commentary": "string"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 422 · 429 Rate limited · 500 Server error · 502 Network error

Edit an existing LinkedIn post

misc.linkedin.editPost · requires x-api-key

Request body application/json

• teamId string required
• postId string required
• description string required

Example

curl -X PATCH "https://api.siaran.my/api/v1/misc/linkedin/post" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "postId": "POST_ID",
    "description": "Hello from Siar"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Delete a LinkedIn post

misc.linkedin.deletePost · requires x-api-key

Request body application/json

• teamId string required
• postId string required

Example

curl -X DELETE "https://api.siaran.my/api/v1/misc/linkedin/post" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "postId": "POST_ID"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Edit an existing LinkedIn comment

misc.linkedin.editComment · requires x-api-key

Request body application/json

• teamId string required
• commentId string required
• text string required min length 1max length 1,250

Example

curl -X PATCH "https://api.siaran.my/api/v1/misc/linkedin/comment" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "commentId": "COMMENT_ID",
    "text": "Hello from Siar"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Delete a LinkedIn comment

misc.linkedin.deleteComment · requires x-api-key

Request body application/json

• teamId string required
• commentId string required

Example

curl -X DELETE "https://api.siaran.my/api/v1/misc/linkedin/comment" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "commentId": "COMMENT_ID"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Add a media item (photo/video) using uploadId and category

misc.google_business.addMedia · requires x-api-key

Request body application/json

• teamId string required
• uploadId string required
• category string default "ADDITIONAL"
  One of: CATEGORY_UNSPECIFIED COVER PROFILE LOGO EXTERIOR INTERIOR PRODUCT AT_WORK FOOD_AND_DRINK MENU COMMON_AREA ROOMS TEAMS ADDITIONAL
• description string max length 2,000

Example

curl -X POST "https://api.siaran.my/api/v1/misc/google-business/media" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "uploadId": "UPLOAD_ID"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

List Google Business media items

misc.google_business.listMedia · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/google-business/media?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Delete Google Business media item

misc.google_business.deleteMedia · requires x-api-key

Request body application/json

• teamId string required
• mediaName string required

Example

curl -X DELETE "https://api.siaran.my/api/v1/misc/google-business/media" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "mediaName": "Example"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Delete a Google Business post

misc.google_business.deletePost · requires x-api-key

Request body application/json

• teamId string required
• postId string required

Example

curl -X DELETE "https://api.siaran.my/api/v1/misc/google-business/post" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "postId": "POST_ID"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Get Google Business location profile

misc.google_business.getLocation · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/google-business/location?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Update Google Business location profile fields

misc.google_business.updateLocation · requires x-api-key

Request body application/json

• teamId string required
• validateOnly boolean
• title string nullable max length 255
• profile object nullable
  1 field

  • description string max length 1,500
• websiteUri string nullable uri
• phoneNumbers object nullable
  2 fields

  • primaryPhone string
  • additionalPhones string[]
• categories object nullable
  2 fields

  • primaryCategory object
    1 field

    • name string
  • additionalCategories object[]
    1 field

    • name string
• storefrontAddress object nullable
  6 fields

  • regionCode string
  • languageCode string
  • postalCode string
  • administrativeArea string
  • locality string
  • addressLines string[]
• regularHours object nullable
  1 field

  • periods object[]
    4 fields

    • openDay string
      One of: MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
    • openTime object | string
      One of 2 shapes

      Variant 1

      • hours integer ≥ 0≤ 23
      • minutes integer ≥ 0≤ 59
      • seconds integer ≥ 0≤ 59
      • nanos integer ≥ 0≤ 999999999

      string

    • closeDay string
      One of: MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
    • closeTime object | string
      One of 2 shapes

      Variant 1

      • hours integer ≥ 0≤ 23
      • minutes integer ≥ 0≤ 59
      • seconds integer ≥ 0≤ 59
      • nanos integer ≥ 0≤ 999999999

      string

• specialHours object nullable
  1 field

  • specialHourPeriods object[]
    5 fields

    • startDate object
      3 fields

      • year integer
      • month integer ≥ 1≤ 12
      • day integer ≥ 1≤ 31
    • endDate object
      3 fields

      • year integer
      • month integer ≥ 1≤ 12
      • day integer ≥ 1≤ 31
    • openTime object | string
      One of 2 shapes

      Variant 1

      • hours integer ≥ 0≤ 23
      • minutes integer ≥ 0≤ 59
      • seconds integer ≥ 0≤ 59
      • nanos integer ≥ 0≤ 999999999

      string

    • closeTime object | string
      One of 2 shapes

      Variant 1

      • hours integer ≥ 0≤ 23
      • minutes integer ≥ 0≤ 59
      • seconds integer ≥ 0≤ 59
      • nanos integer ≥ 0≤ 999999999

      string

    • closed boolean
• moreHours object[] nullable
  2 fields

  • hoursTypeId string
  • periods object[]
    4 fields

    • openDay string
      One of: MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
    • openTime object | string
      One of 2 shapes

      Variant 1

      • hours integer ≥ 0≤ 23
      • minutes integer ≥ 0≤ 59
      • seconds integer ≥ 0≤ 59
      • nanos integer ≥ 0≤ 999999999

      string

    • closeDay string
      One of: MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
    • closeTime object | string
      One of 2 shapes

      Variant 1

      • hours integer ≥ 0≤ 23
      • minutes integer ≥ 0≤ 59
      • seconds integer ≥ 0≤ 59
      • nanos integer ≥ 0≤ 999999999

      string

• openInfo object nullable
• serviceArea object nullable
• latlng object nullable
  2 fields

  • latitude number
  • longitude number

Example

curl -X PATCH "https://api.siaran.my/api/v1/misc/google-business/location" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Update Google Business regular/special/more hours

misc.google_business.updateHours · requires x-api-key

Request body application/json

• teamId string required
• validateOnly boolean
• fields string[] required min 1 itemsmax 3 items
  One of: regularHours specialHours moreHours
• regularHours object nullable
  1 field

  • periods object[]
    4 fields

    • openDay string
      One of: MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
    • openTime object | string
      One of 2 shapes

      Variant 1

      • hours integer ≥ 0≤ 23
      • minutes integer ≥ 0≤ 59
      • seconds integer ≥ 0≤ 59
      • nanos integer ≥ 0≤ 999999999

      string

    • closeDay string
      One of: MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
    • closeTime object | string
      One of 2 shapes

      Variant 1

      • hours integer ≥ 0≤ 23
      • minutes integer ≥ 0≤ 59
      • seconds integer ≥ 0≤ 59
      • nanos integer ≥ 0≤ 999999999

      string

• specialHours object nullable
  1 field

  • specialHourPeriods object[]
    5 fields

    • startDate object
      3 fields

      • year integer
      • month integer ≥ 1≤ 12
      • day integer ≥ 1≤ 31
    • endDate object
      3 fields

      • year integer
      • month integer ≥ 1≤ 12
      • day integer ≥ 1≤ 31
    • openTime object | string
      One of 2 shapes

      Variant 1

      • hours integer ≥ 0≤ 23
      • minutes integer ≥ 0≤ 59
      • seconds integer ≥ 0≤ 59
      • nanos integer ≥ 0≤ 999999999

      string

    • closeTime object | string
      One of 2 shapes

      Variant 1

      • hours integer ≥ 0≤ 23
      • minutes integer ≥ 0≤ 59
      • seconds integer ≥ 0≤ 59
      • nanos integer ≥ 0≤ 999999999

      string

    • closed boolean
• moreHours object[] nullable
  2 fields

  • hoursTypeId string
  • periods object[]
    4 fields

    • openDay string
      One of: MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
    • openTime object | string
      One of 2 shapes

      Variant 1

      • hours integer ≥ 0≤ 23
      • minutes integer ≥ 0≤ 59
      • seconds integer ≥ 0≤ 59
      • nanos integer ≥ 0≤ 999999999

      string

    • closeDay string
      One of: MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
    • closeTime object | string
      One of 2 shapes

      Variant 1

      • hours integer ≥ 0≤ 23
      • minutes integer ≥ 0≤ 59
      • seconds integer ≥ 0≤ 59
      • nanos integer ≥ 0≤ 999999999

      string

Example

curl -X PATCH "https://api.siaran.my/api/v1/misc/google-business/location/hours" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "fields": [
      "regularHours"
    ]
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Get Google Business location attributes

misc.google_business.getAttributes · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/google-business/location/attributes?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Update Google Business location attributes

misc.google_business.updateAttributes · requires x-api-key

Request body application/json

• teamId string required
• attributeMask string
• attributes object[] nullable
  4 fields

  • name string required
  • values any[] nullable
  • repeatedEnumValue object
    1 field

    • setValues string[]
  • uriValues object[]
    1 field

    • uri string required min length 1

Example

curl -X PATCH "https://api.siaran.my/api/v1/misc/google-business/location/attributes" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

List available Google Business attributes

misc.google_business.listAvailableAttributes · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/google-business/location/attributes/available?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

List the search terms customers used to find the location

misc.google_business.listSearchKeywords · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/google-business/location/search-keywords?teamId=TEAM_ID&startMonth=string&endMonth=string" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

List available Google Business categories

misc.google_business.listCategories · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/google-business/location/categories/available?teamId=TEAM_ID&regionCode=string&languageCode=string" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Get Google Business service list

misc.google_business.getServiceList · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/google-business/location/service-list?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Update Google Business service list

misc.google_business.updateServiceList · requires x-api-key

Request body application/json

• teamId string required
• fields string[] required min 1 itemsmax 1 items
  One of: serviceItems
• serviceItems object[] nullable

Example

curl -X PATCH "https://api.siaran.my/api/v1/misc/google-business/location/service-list" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "fields": [
      "serviceItems"
    ]
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Get Google Business food menus

misc.google_business.getFoodMenus · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/google-business/location/food-menus?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Update Google Business food menus

misc.google_business.updateFoodMenus · requires x-api-key

Request body application/json

• teamId string required
• fields string[] required min 1 itemsmax 1 items
  One of: menus
• menus object[] nullable

Example

curl -X PATCH "https://api.siaran.my/api/v1/misc/google-business/location/food-menus" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "fields": [
      "menus"
    ]
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

List Google Business place action links

misc.google_business.listPlaceActionLinks · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/google-business/location/place-action-links?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Create Google Business place action link

misc.google_business.createPlaceActionLink · requires x-api-key

Request body application/json

• teamId string required
• placeActionLink object required
  4 fields

  • name string
  • uri string uri
  • placeActionType string
    One of: APPOINTMENT ONLINE_APPOINTMENT DINING_RESERVATION FOOD_ORDERING FOOD_DELIVERY FOOD_TAKEOUT SHOP_ONLINE
  • isPreferred boolean

Example

curl -X POST "https://api.siaran.my/api/v1/misc/google-business/location/place-action-links" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "placeActionLink": {}
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Update Google Business place action link

misc.google_business.updatePlaceActionLink · requires x-api-key

Request body application/json

• teamId string required
• placeActionLink object required
  4 fields

  • name string
  • uri string uri
  • placeActionType string
    One of: APPOINTMENT ONLINE_APPOINTMENT DINING_RESERVATION FOOD_ORDERING FOOD_DELIVERY FOOD_TAKEOUT SHOP_ONLINE
  • isPreferred boolean
• name string required
• fields string[] required min 1 itemsmax 3 items
  One of: uri placeActionType isPreferred

Example

curl -X PATCH "https://api.siaran.my/api/v1/misc/google-business/location/place-action-links" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "placeActionLink": {},
    "name": "Example",
    "fields": [
      "uri"
    ]
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Delete Google Business place action link

misc.google_business.deletePlaceActionLink · requires x-api-key

Request body application/json

• teamId string required
• name string required

Example

curl -X DELETE "https://api.siaran.my/api/v1/misc/google-business/location/place-action-links" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "name": "Example"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Start a new Google Reviews import

misc.google_business.importReviews · requires x-api-key

Request body application/json

• teamId string required
• count integer required ≥ 1

Example

curl -X POST "https://api.siaran.my/api/v1/misc/google-business/reviews/import" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "count": 1
  }'

Response 201

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 409 Conflict · 429 Rate limited · 500 Server error · 502 Network error

Get review import status list

misc.google_business.getReviewImportStatus · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/google-business/reviews/import?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Get review import by ID

misc.google_business.getReviewImportById · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/google-business/reviews/import/IMPORTID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

List imported Google Reviews

misc.google_business.getReviews · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/google-business/reviews?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Get a single imported Google Review

misc.google_business.getReviewById · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/google-business/reviews/REVIEWID?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Reply to a Google Review (creates or updates the owner reply)

misc.google_business.replyToReview · requires x-api-key

Parameters

Request body application/json

• teamId string required
• comment string required min length 1max length 4,096

Example

curl -X PUT "https://api.siaran.my/api/v1/misc/google-business/reviews/REVIEWID/reply" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "comment": "string"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Delete the owner reply from a Google Review

misc.google_business.deleteReviewReply · requires x-api-key

Parameters

Request body application/json

• teamId string required

Example

curl -X DELETE "https://api.siaran.my/api/v1/misc/google-business/reviews/REVIEWID/reply" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Get subreddit post requirements (flair required/enabled)

misc.reddit.getPostRequirements · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/reddit/post-requirements?teamId=TEAM_ID&subreddit=string" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Get subreddit flairs list

misc.reddit.getSubredditFlairs · requires x-api-key

Parameters

Example

curl -X GET "https://api.siaran.my/api/v1/misc/reddit/subreddit-flairs?teamId=TEAM_ID&subreddit=string" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Edit an existing Reddit post

misc.reddit.editPost · requires x-api-key

Request body application/json

• teamId string required
• postId string required
• description string required

Example

curl -X PATCH "https://api.siaran.my/api/v1/misc/reddit/post" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "postId": "POST_ID",
    "description": "Hello from Siar"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Delete a Reddit post

misc.reddit.deletePost · requires x-api-key

Request body application/json

• teamId string required
• postId string required

Example

curl -X DELETE "https://api.siaran.my/api/v1/misc/reddit/post" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "postId": "POST_ID"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Edit an existing Reddit comment

misc.reddit.editComment · requires x-api-key

Request body application/json

• teamId string required
• commentId string required
• text string required min length 1max length 10,000

Example

curl -X PATCH "https://api.siaran.my/api/v1/misc/reddit/comment" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "commentId": "COMMENT_ID",
    "text": "Hello from Siar"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Delete a Reddit comment

misc.reddit.deleteComment · requires x-api-key

Request body application/json

• teamId string required
• commentId string required

Example

curl -X DELETE "https://api.siaran.my/api/v1/misc/reddit/comment" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "commentId": "COMMENT_ID"
  }'

Response 200

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

Search for Instagram Business/Creator user by username

misc.instagram.businessDiscovery · requires x-api-key

Parameters