Free Grind

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

Response type: AcceptedLegalAgreementsResponse (undocumented).

GET /v3/me/legal-agreements

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

Response type: LegalAgreementsInfo (undocumented).

GET /v3/legal-agreements

Returns the consent prompt for a surface and whether to show it. Works with or without Authorization.

GET /v1/consent/experience

Query:

  • surface — string, "AI_CONSENT"; "PRIVACY_SETTINGS" is accepted but publishes no experience

Response:

  • surface — string, the requested surface
  • experienceType — string, "AGREEMENT" (accept or decline each consent) or "NOTICE" (informational)
  • experienceVersion — string, e.g. "ai-consent.agreement.1"; pass it to Get consent copy and back in Submit consent decisions
  • variant — string, experiment treatment or null
  • promptRequired — boolean, true when the prompt should be shown
  • consents — array of objects
    • consentType — string, "AI_USAGE_AND_FEATURES" or "AI_SENSITIVE_DATA_TRAINING"
    • preselectedValue — boolean, the value to show as selected
    • responded — boolean, appears to be true once a decision for this type was submitted

Errors:

  • 400 — urn:gr:err:parameter when surface is missing or unknown; urn:gr:err:bad_request when the surface publishes no experience.

Returns the localized texts of a consent experience version. Works with or without Authorization.

GET /v1/consent/copy

Query:

  • version — string, experienceVersion from Get consent experience, e.g. "ai-consent.agreement.1" or "ai-consent.notice.1"

Response:

  • experienceVersion — string, the requested version
  • resolvedLocale — string, locale of the texts, e.g. "en"
  • strings — object of strings keyed by text id. ai-consent.agreement.1 has aiConsent.agreement. + screenTitle, eyebrow, title, body, offLimitsBody, personalizationTitle, personalizationBody, trainingTitle, trainingBody, accept, decline, continue, confirm, incomplete, incompleteConfirm; ai-consent.notice.1 has aiConsent.agreement. + screenTitle, eyebrow, title, nonEuBody, nonEuOffLimits, nonEuWithdrawal, gotIt

Errors:

  • 400 — urn:gr:err:parameter when version is missing; urn:gr:err:bad_request when the version is not published.

Requires Authorization.

POST /v1/consent

Body:

  • submissionId — string, random UUID, reused when retrying the same submission
  • surface — string, "AI_CONSENT" or "PRIVACY_SETTINGS"
  • surfaceContext — string, "ONBOARDING" or "IN_APP"
  • experimentTreatment — string, variant from Get consent experience, optional
  • decisions — array of decisions, at most one per consent type
    • consentType — string, "AI_USAGE_AND_FEATURES" or "AI_SENSITIVE_DATA_TRAINING"
    • consentValue — boolean, true to consent
    • experienceVersion — string, experienceVersion the decision was made on
    • policyVersion — string, optional

Errors:

  • 400 — urn:gr:err:internal_error when the body does not parse, including {}.

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

Body type: ConsentRequest (undocumented).

PUT /v1/opt-out

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.