Skip to main content
POST
ads.account.invitation.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
accountId
string
required

Connected account from social.accounts.list.

Required string length: 1 - 256
adAccountId
string
required

Google Ads customer ID.

Required string length: 1 - 64
Pattern: ^\d+$
email
string<email>
required

Address to invite.

Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
role
enum<string>
required

Access role to grant.

Available options:
ADMIN,
STANDARD,
READ_ONLY,
EMAIL_ONLY
validateOnly
boolean
default:false

Check without sending an invitation.

Response

The result

status
enum<string>
required

Validated without sending, sent, or awaiting another administrator approval.

Available options:
VALIDATED,
PENDING,
PENDING_APPROVAL
validated
boolean
required

Whether only validation was requested.

invitationId
string | null

Native Google invitation ID, when issued.

reviewId
string | null

Native review ID for a request awaiting approval.