Skip to content

PromotedActivityInput

What you send to promote something.

Type Parameter Default type
TCustom Record<string, unknown>
actor: string;

Free-form, and never overwritten: these routes are server-token only. e.g. “sponsor:nike”.


optional audience?: string[] | null;

Which feeds to target. Omit (or null) to reach EVERY user, including brand-new ones whose feed is otherwise empty. Otherwise feed refs the reader must follow — targeting is the follow graph, because we hold no user attributes. Max 20; a reader matching ANY of them is eligible.


optional custom?: TCustom;

optional expires_at?: string | null;

ISO timestamp, must be in the future. Null (or omitted) means “until you retract it”.


object: string;

optional starts_at?: string;

ISO timestamp. Defaults to now; nothing is served before it.


verb: string;