Skip to content
Infinite Audience Docs

Update the caller's own notification preferences

PUT
/v1/settings/notifications
curl --request PUT \
  --url https://dev-api.infiniteaudience.ai/v1/settings/notifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "notification_preferences": { "segment.ready": true, "segment.failed": true, "delivery.completed": true, "delivery.failed": true } }'

Updates the caller’s own email notification preferences. Only these four event types are settable. Requires ‘account’ scope.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
notification_preferences
required

Per-event-type email opt-in flags, keyed by the same four event strings orgs can already configure a webhook for. Absent/false = opt-out (default) — no email until the user explicitly opts in.

object
segment.ready
boolean
segment.failed
boolean
delivery.completed
boolean
delivery.failed
boolean
Examplegenerated
{
  "notification_preferences": {
    "segment.ready": true,
    "segment.failed": true,
    "delivery.completed": true,
    "delivery.failed": true
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

Preferences updated.

Media typeapplication/json
object
ok
required
boolean
Example
{
  "ok": true
}

400

Section titled “400”

Invalid request — malformed body, missing required attribute, or failed validation. See error and message for details.

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
key
additional properties
any
Examples
Examplevalidation_error
{
  "error": "Bad Request",
  "code": "MISSING_SEGMENTS",
  "message": "segment_ids is required for filter audiences."
}

401

Section titled “401”

Missing or invalid Bearer token. Obtain one via POST /v1/auth/token. When a token was supplied but rejected, code distinguishes TOKEN_EXPIRED (the token’s lifetime has passed — request a new one via POST /v1/auth/token and retry) from TOKEN_INVALID (malformed or revoked — re-authenticate).

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
key
additional properties
any
Examples
{
  "error": "Unauthorized: Missing or invalid Authorization header"
}

403

Section titled “403”

Token is valid but lacks the required scope for this endpoint. Check the endpoint description for the required scope (discovery, purchase, or account).

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
key
additional properties
any
Examples
Examplemissing_scope
{
  "error": "SCOPE_REQUIRED",
  "message": "This endpoint requires the purchase scope."
}