Mailboxes

Connect a Google Workspace

Two calls. Without emails you get what the Workspace admin must add in Google Admin (a client id and its access list) and, once that is done, every mailbox and alias in the Workspace. With emails those addresses are connected as senders. No passwords and no sign-in per mailbox.

CostWhat it doesKey scopes
FreeWritesargorant:manage_lists
post/api/v1/inboxes/google-workspace

Request

  • Base URL: https://app.argorant.com
  • URL: https://app.argorant.com/api/v1/inboxes/google-workspace
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Any unique text up to 128 characters. A retry with the same key and the same body within 24 hours returns the first answer (with the header Idempotent-Replayed: true) instead of doing the work twice. The same key with another body answers 409 idempotency_conflict.

X-Request-Idstring

Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.

Request body

admin_emailstring email required

A Workspace admin address.

emailsstring[]

Mailboxes to connect. Leave out to only list them.

Example request

{
  "admin_email": "admin@northgate-advisory.com"
}

Response

Listing or Connected

domainsstring[]

Changes

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