propose_write

Create a Google account for a store and set it up.

Starts setting up one service. Idempotent per (store, service): while a setup is queued, running, waiting on the merchant or failed, a second request returns that one (idempotent: true) and starts nothing. Creating an account cannot be undone, so the credential needs auto-apply on. client_email is the Google account the merchant is given access with.

post/api/v1/provisioning/start

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/provisioning/start
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: write)

Request body

store_idstring uuid

The store to act on. Defaults to the store the credential was issued for.

service'google_ads' | 'google_analytics' | 'google_merchant' | 'google_search_console' required

Which Google account.

client_emailstring email required

The Google account that receives access to the new account.

Response

Result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.