Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Connect Google Ads, Meta Ads, and TikTok Ads accounts via OAuth.
curl -X GET "https://api.adrelay.dev/v1/connections/google_ads/authorize" \
-H "X-API-Key: $ADRELAY_API_KEY"
curl -X GET "https://api.adrelay.dev/v1/connections/meta_ads/authorize" \
-H "X-API-Key: $ADRELAY_API_KEY"
ads_management, ads_read. The user must be an admin or advertiser on the Meta Business account.
curl -X GET "https://api.adrelay.dev/v1/connections/tiktok_ads/authorize" \
-H "X-API-Key: $ADRELAY_API_KEY"
{
"authorize_url": "https://accounts.google.com/o/oauth2/v2/auth?client_id=...&redirect_uri=...&scope=...",
"platform": "google_ads"
}
authorize_url in their browser. After granting access, they will be redirected back to AdRelay, and the connection will be established automatically.
curl -X POST "https://api.adrelay.dev/v1/connections/sync" \
-H "X-API-Key: $ADRELAY_API_KEY"
| Status | Description |
|---|---|
ACTIVE | Connection is healthy. Tokens are valid and API calls will succeed. |
PENDING | OAuth flow has been initiated but not yet completed by the user. |
REVOKED | Access has been revoked by the user or tokens have expired beyond refresh. Re-authorization is required. |
ERROR | An error occurred with the connection. Check the connection details for more information. |
curl -X GET "https://api.adrelay.dev/v1/connections" \
-H "X-API-Key: $ADRELAY_API_KEY"
{
"connections": [
{
"id": "conn_abc123",
"platform": "google_ads",
"status": "ACTIVE",
"label": "Main Google Account",
"remote_account_id": "123-456-7890",
"created_at": "2026-03-01T12:00:00Z",
"last_synced_at": "2026-03-21T08:00:00Z"
},
{
"id": "conn_def456",
"platform": "meta_ads",
"status": "ACTIVE",
"label": null,
"remote_account_id": "act_987654321",
"created_at": "2026-03-05T10:00:00Z",
"last_synced_at": "2026-03-21T08:00:00Z"
}
]
}
curl -X PATCH "https://api.adrelay.dev/v1/connections/conn_abc123" \
-H "X-API-Key: $ADRELAY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"label": "US Google Ads Account"}'
curl -X DELETE "https://api.adrelay.dev/v1/connections/conn_abc123" \
-H "X-API-Key: $ADRELAY_API_KEY"