Ad Accounts

Invite a user to an ad account by email

Changed on

Emails someone an invitation to a Google Ads account with the access role you choose, for example to hand a client account you created under your manager to its owner.

Creates a user access invitation (Google's CustomerUserAccessInvitationService) on adAccountId. The connection's Google user needs admin access to that account, directly or through a manager above it, which is the case for an account created with POST /v1/ads/accounts. The recipient accepts from the email, possibly with another Google account. When Google requires multi-party approval, nothing is sent until a second admin of the account approves the request in Google Ads: the response then has status: PENDING_APPROVAL and a multiPartyAuthReviewId instead of an invitationId, which DELETE /v1/ads/accounts/user-invitations/pending-approvals withdraws. Not idempotent: Google refuses a second invitation while the email has one pending or awaiting approval. Google has no server-side check for this call, so validateOnly: true reads the account's invitations with the same credentials (proving the account is reachable) and fails if the email already has a pending one, without sending anything.

post/v1/ads/accounts/user-invitations

Request

  • Base URL: https://zernio.com/api
  • URL: https://zernio.com/api/v1/ads/accounts/user-invitations
  • Auth: HTTP bearer

Request body

accountIdstring required

Google ads SocialAccount id.

adAccountIdstring required

Google Ads customer id to invite the user to, digits only.

emailAddressstring email required
accessRole'ADMIN' | 'STANDARD' | 'READ_ONLY' | 'EMAIL_ONLY' required

ADMIN manages the account and its users, STANDARD edits campaigns, READ_ONLY views them, EMAIL_ONLY only receives the account's emails.

validateOnlyboolean

Response

Validated only (validateOnly true), nothing sent

customerIdstring
emailAddressstring
accessRole'ADMIN' | 'STANDARD' | 'READ_ONLY' | 'EMAIL_ONLY'

ADMIN manages the account and its users, STANDARD edits campaigns, READ_ONLY views them, EMAIL_ONLY only receives the account's emails.

status'PENDING' | 'PENDING_APPROVAL'

PENDING once the email is sent; PENDING_APPROVAL while Google waits for a second admin's multi-party approval.

invitationIdstring nullable

Null on validateOnly and while the invitation awaits multi-party approval.

multiPartyAuthReviewIdstring nullable

Google's multi-party approval review id when status is PENDING_APPROVAL.

validateOnlyboolean

Changes