Skip to main content
POST
Invite one exact advertiser recipient

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

advertiserId
string
required
Pattern: ^\d+$

Body

application/json
recipientEmail
string<email>
required
Maximum string length: 320
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
operatorDomain
string
required
Maximum string length: 253
Pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)+$
requestedRoleSlug
enum<string>
required
Available options:
advertiser-viewer,
advertiser-editor,
advertiser-admin
expectedEligibilityRevision
string
required
Pattern: ^[0-9a-f]{64}$
idempotencyKey
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Invite one exact advertiser recipient

data
object
required

Exact-recipient invitation audit state. The one-time claim bearer is delivered only by email and is never returned.

error
enum<string> | null
required
Available options:
null