integrations

Connect

Validate the key against Semrush before storing it, so a typo never reads as connected.

post/integrations/semrush/connect

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Headers

timezonestring
x-user-idstring nullable
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable
organization-idstring nullable

Request body

api_keystring password required

Semrush v4 API key from My profile > API Keys

Response

Successful Response

integration_idstring required
statusstring required
projects_listedboolean
seo_reportsboolean
seo_reports_reasonstring nullable
seo_reports_urlstring nullable
maps_rankingsboolean
map_campaignsinteger nullable
capabilitiesobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.