Start a partner application for the person

Starts a partner application with the person’s details and returns application_id and application_token. Only call it when the person has asked to join. No text is sent by this call. Next: partner_send_code.

post/applications

Request

  • Base URL: https://buzzmebro.com/api/partner/v1
  • URL: https://buzzmebro.com/api/partner/v1/applications
  • Auth: none declared

Request body

namestring required

The person’s name.

mobile_phonestring required

The person’s own Canadian mobile number. We text it a code.

emailstring required

The person’s email.

persona'front_desk' | 'property_manager' | 'condo_board' | 'leasing_agent' | 'mover' | 'student_housing' | 'tenant_insurance' | 'co_living' | 'telecom' | 'listing_site' | 'relocation' | 'landlord' | 'move_in_service' | 'delivery' | 'creator' | 'other' required

The partner type: how they meet renters (front desk or building staff, leasing agent, mover, tenant insurance, co-living, university, telecom, listing site, relocation, landlord, move-in service, delivery).

payouts_offboolean

Optional: true for organisations that cannot take money (for example a university or a settlement agency). Their residents still get the perk; no payouts are ever made.

buildingstring

Optional: the building or company they work with.

employer_okboolean

If they work for a building or concierge company: has their employer allowed it?

Response

OK

object required

Changes

No recorded changes to this operation across all 1 revision of this API.