Upward API documentation
Create and manage Upward companies from your own platform. Every endpoint is JSON over HTTPS, documented here with a live console you can send real requests from.
https://www.upward.page/api/public/v1The main address is now upward.page. tryupward.page will remain online as a fallback for the previous system, so existing integrations keep working — point new integrations at upward.page.
Endpoints
- POST
/api/public/v1/crm/create-meetingAdd a virtual or in-person meeting to a member's CRM calendar. - POST
/api/public/v1/crm/create-callSchedule a phone call on a member's CRM calendar. - POST
/api/public/v1/crm/create-emailAdd an email activity to a member's CRM calendar. - POST
/api/public/v1/crm/create-smsAdd a text-message activity — requires an active SMS Center number. - GET
/api/public/v1/marketsEvery active vertical market and the key used when creating a company. - POST
/api/public/v1/create-companyProvision a company with branding and an owner account. - GET
/api/public/v1/companies/{id}Read a single company, its branding and plan.Planned - GET
/api/public/v1/companiesPaginated list of the companies created with your key.Planned - PATCH
/api/public/v1/companies/{id}/brandingChange logos and brand colours after creation.Planned - POST
/api/public/v1/create-memberCreate a team member under your company. - POST
/api/public/v1/ssoSign one of your people straight into their back office with a single-use login link. - GET
/api/public/v1/memberRead one member's details. - PATCH
/api/public/v1/memberUpdate a member; only the fields you send are changed. - GET
/api/public/v1/companies/{id}/membersTeam members belonging to a company.Planned - POST
/api/public/v1/create-leadPush a lead into a member's CRM pipeline. - POST
/api/public/v1/create-contactCreate or update a CRM contact for a member. - GET
/api/public/v1/crm-optionsList pipeline stages, lead sources and every fixed CRM choice. - POST
/api/public/v1/create-eventCreate a bookable meeting type in a member's Schedule Meeting module. - GET
/api/public/v1/event-optionsEvery accepted value for create-event. - GET
/api/public/v1/bookingsMeetings booked through a company's scheduling pages.Planned - GET
/api/public/v1/billing/plansThe plans your company offers, with the plan_id to use in Set a plan. - POST
/api/public/v1/billing/subscriptionRecord the plan someone bought in your own payment system. - GET
/api/public/v1/billing/subscriptionThe person's current plan, interval, start date and renewal date. - POST
/api/public/v1/billing/cancelEnd a plan now, or when the paid period runs out.