Ads · Ad Accounts

Invite a user to an ad account by email

Invites a user to an ad account by email. Works with Google Ads.

POSThttps://api.pozy.ai/v1/ads/accounts/user-invitations
Google WorkspaceinviteAdAccountUser

Guide: Google Ads

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the ads resource group disabled get 403 resource_group_disabled. Authentication

Request body

application/json, required

  • accountIdstringrequired
  • adAccountIdstringrequired
  • emailAddressstring (email)required
  • accessRolestringrequired

    One of ADMIN, STANDARD, READ_ONLY, EMAIL_ONLY.

  • validateOnlyboolean

    Default false.

Example

curl -X POST "https://api.pozy.ai/v1/ads/accounts/user-invitations" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "696e0b682d0a31188e7a2ba9",
  "adAccountId": "666219aad7bab67ace411e4f",
  "emailAddress": "alex@example.com",
  "accessRole": "ADMIN"
}'

Response

200 on success

  • customerIdstring
  • emailAddressstring
  • accessRolestring

    One of ADMIN, STANDARD, READ_ONLY, EMAIL_ONLY.

  • statusstring

    One of PENDING, PENDING_APPROVAL.

  • invitationIdstring

    Can be null.

  • multiPartyAuthReviewIdstring

    Can be null.

  • validateOnlyboolean
200 response
{
  "customerId": "691909ff82eb5ed7c816716d",
  "emailAddress": "alex@example.com",
  "accessRole": "ADMIN",
  "status": "PENDING",
  "invitationId": "64eb9a58e6591a84f84078cc",
  "multiPartyAuthReviewId": "642ccdca6d51812c9e63a7a0",
  "validateOnly": true
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Ad Accounts

GETList comments on an adPOSTReply to an ad commentPOSTHide or unhide an ad commentDELDelete an ad commentGETList TikTok Business CentersGETAd account change / audit logGETA/B tests and lift studiesGETList Instagram ad identitiesGETList Instagram posts to boostGETList advertisable appsGETGet iOS 14 campaign limitsGETBusinesses listGETBusiness usersGETPage users of a businessPOSTAssign a user to a PageDELRemove a user from a PageGETList ad labelsPOSTCreate a Google Ads labelPATCHUpdate a Google Ads labelDELRemove a Google Ads labelPOSTAttach a Google Ads labelDELDetach a Google Ads labelGETList high-demand periodsPOSTSchedule a budget increaseGETList value rule setsPOSTCreate a value rule setGETRead a value rule setPUTReplace a value rule setDELDelete a value rule setGETList negative keyword listsPOSTCreate a negative keyword listGETGet a negative keyword listPUTRename a negative keyword listDELDelete a negative keyword listPUTReplace negative list keywordsGETList account calloutsPOSTAdd account calloutsPUTUpdate account calloutsDELRemove account calloutGETList account sitelinksPOSTAdd account sitelinksPUTUpdate account sitelinksDELRemove account sitelinkGETList account snippetsPOSTAdd account snippetsPUTUpdate account snippetsDELRemove account snippetGETGet manager account hierarchyPOSTInvite a client account to a managerPATCHAccept, decline, cancel or end a manager linkGETGet ad account billingPOSTSet up ad account billing (monthly invoicing)GETList user access invitationsDELRevoke a user access invitationGETList invitations awaiting multi-party approvalDELWithdraw an invitation awaiting multi-party approvalGETAd account usersPOSTAssign a user to an ad accountDELRemove a user from an ad accountGETAd account financesGETCheck an ad account before creating adsGETRead an ad account's campaigns and ad sets liveGETList ad accountsPOSTCreate ad accountPATCHUpdate ad account settingsGETGet ad account DSA defaultsGETGet DSA recommendationsGETList custom conversionsPOSTCreate custom conversionGETList TikTok ad pixels