Legal agreements, WIP

NOTE

This page is a work in progress. Endpoints below haven't been fully researched.

Get subscriber sponsored content agreement, WIP

Response type: SponsoredContentConsentAgreementResponse (undocumented).

GET /v5/legal-agreements/subscriber-sponsored-content

Accept subscriber sponsored content agreement, WIP

Body type: SponsoredContentAcceptConsentRequest (undocumented).

POST /v5/legal-agreements/subscriber-sponsored-content

Delete subscriber sponsored content agreement, WIP

Note: this DELETE endpoint accepts a request body.

Body type: SponsoredContentAcceptConsentRequest (undocumented).

DELETE /v5/legal-agreements/subscriber-sponsored-content

Accept ban agreement, WIP

Acknowledges the community-guideline agreement shown during a timed ban. Flips isAgreementCompleted in the session banDetails.

Body type: BanAgreementRequest (undocumented).

POST /v1/agreements/ban

Get accepted legal agreements, WIP

Response type: AcceptedLegalAgreementsResponse (undocumented).

GET /v3/me/legal-agreements

Accept legal agreements, WIP

Body type: AcceptLegalAgreementsRequest (undocumented).

PUT /v3/me/legal-agreements

Get vip matchmaker agreement, WIP

Response type: VipMatchmakerConsentAgreementResponse (undocumented).

GET /v5/legal-agreements/vip-matchmaker

Accept vip matchmaker agreement, WIP

Body type: VipMatchmakerAcceptConsentRequest (undocumented).

POST /v5/legal-agreements/vip-matchmaker

Delete vip matchmaker agreement, WIP

Body type: VipMatchmakerAcceptConsentRequest (undocumented).

DELETE /v5/legal-agreements/vip-matchmaker

Get top picks agreement v4, WIP

Response type: TopPicksConsentAgreementResponse (undocumented).

GET /v4/legal-agreements/top-picks

Accept top picks agreement v4, WIP

Body type: TopPicksAcceptConsentRequest (undocumented).

POST /v4/legal-agreements/top-picks

Delete top picks agreement v4, WIP

DELETE /v4/legal-agreements/top-picks

Get top picks agreement v5, WIP

Response type: TopPicksConsentAgreementResponse (undocumented).

GET /v5/legal-agreements/top-picks

Delete top picks agreement v5, WIP

Body type: TopPicksAcceptConsentRequest (undocumented).

DELETE /v5/legal-agreements/top-picks

Get right now agreement (deprecated), WIP

Removed in the official Android client v26.13.0. The client no longer fetches a Right Now consent agreement, and creating a Right Now post no longer requires accepting one.

Response type: RightNowConsentAgreementResponse (undocumented).

GET /v4/legal-agreements/right-now

Accept right now agreement (deprecated), WIP

Removed in the official Android client v26.13.0. The client no longer accepts a Right Now consent agreement, and creating a Right Now post no longer requires one.

Body type: RightNowAcceptConsentRequest (undocumented).

POST /v4/legal-agreements/right-now

Get legal agreements info, WIP

Response type: LegalAgreementsInfo (undocumented).

GET /v3/legal-agreements

Get opt out status (deprecated), WIP

Superseded by Get opt statuses.

POST /v1/opt-out

Body:

• optOutType — string, e.g. "TOP_PICKS"

Response:

• isOptedOut — boolean

Set opt out consent, WIP

Body type: ConsentRequest (undocumented).

PUT /v1/opt-out

Delete opt out consent, WIP

Body type: ConsentRequest (undocumented).

DELETE /v1/opt-out

Get opt statuses

Requires Authorization.

Returns the opt-out and opt-in state of several consent types in one call.

POST /v1/opt-status

Body:

• optOutTypes — array of strings, opt-out types to look up, may be empty; known types: "TOP_PICKS", "AI_NON_SENSITIVE", "GAI", "CHAT_SUGGESTIONS", "ALBUM_UPDATES_SHARING"
• optInTypes — array of strings, opt-in types to look up, may be empty; known type: "AI_USAGE_AND_FEATURES"
• includeDerivedOptOuts — boolean, effect unknown, optional

Response:

• optOuts — object keyed by the requested opt-out types; true means opted out
• optIns — object keyed by the requested opt-in types; true means opted in

Errors:

• 400 — A requested type is unknown, or optOutTypes or optInTypes is missing.