Skip to main content
POST
Read Exact Native Budget for Review

Authorizations

x-api-key
string
header
required

A server-side Bily API key created under Settings > AI tools > Access keys. Select the intended workspace before creating it.

Headers

x-bily-organization-id
string

An organization ID returned by GET /context or GET /organizations. Omit it when a scoped key supplies the organization. Otherwise provide it when no organization is selected.

Example:

"org_01J8W7T9G3E6ZQ4M2K5N8P1R0S"

Path Parameters

resourceUrl
string
required

Exact workspace URL returned by GET /context.

Body

application/json
platform
enum<string>
required
Available options:
FACEBOOK,
GOOGLE_ADS
adAccountId
string
required
Pattern: ^(?:act_)?[1-9]\d{0,19}$
sourceAuthority
object
required
payload
object
required

Response

Request completed. Inspect the returned state and any verification fields.

ok
any
required
result
object
required

When canEdit is true, budgetGuard is present and every selection, owner, amount, cadence, currency and source field matches it. Otherwise reason is present and there is no budgetGuard. Do not invent a guard or reuse one for a different owner.