RelayAPI

Validate and store a dedicated advertising credential

Manual credential bootstrap for approved provider apps. RelayAPI performs read-only account discovery before encrypting or persisting the credential and never returns secret material.

POST
/v1/ads/connections
AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_). Invite redemption also accepts a server-derived rlay_session_ bearer for a current user session.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/ads/connections" \  -H "Content-Type: application/json" \  -d '{    "access_token": "pa$$word",    "platform": "meta",    "provider_principal_id": "string"  }'
{  "connection": {    "access_token_expires_at": "2019-08-24T14:15:22Z",    "created_at": "2019-08-24T14:15:22Z",    "credential_version": 0,    "display_name": "string",    "id": "string",    "last_error": "string",    "platform": "meta",    "provider_principal_id": "string",    "refresh_token_expires_at": "2019-08-24T14:15:22Z",    "scopes": [      "string"    ],    "status": "pending",    "updated_at": "2019-08-24T14:15:22Z",    "workspace_id": "string"  },  "validated_ad_accounts": 0}

Found something wrong? Help us improve this page.