Organization API: Customer Portal: Partners

Part of Customer Portal.

GET /api/v1/orgs/{org_slug}/portal/partners/medal/offer

What the brand's Medal quest has to offer the signed-in customer right now.

Use it to decide whether to show a prompt about the quest. show is true only when there is something to do, and state says what:

• no_server: the customer has no server yet, so the prompt is to make one and get Medal.
• free_claimable: a free server of theirs can take a boost.
• paid_claimable: a paid server of theirs can take a boost, and no free one can. The brand decides whether paid servers may take boosts.

show is false for unavailable (the brand's quest is off or has no key), too_new (the account is less than 24 hours old), all_boosted (every server that may take a boost has its maximum), not_eligible (the customer has servers, and none may take a boost) and for a support session acting as the customer.

server is the best server to point at: a free one that can take a boost first, otherwise a paid one. It has id, uuid, name, address (what players join with), plan (free or paid) and boost_memory_mb, the memory a boost adds. offer holds the brand's boost: memory_mb, duration_days, paid_servers, quest_url, signup_url (where a Get Medal button goes) and partner_url. account_age_ok is true once the account is 24 hours old. Only the servers the customer owns count, not servers shared with them. The answer is for this customer only and is never cached.