Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 1.87 KB

partner.md

File metadata and controls

49 lines (32 loc) · 1.87 KB

Partner API Documentation

Only account creation is done at this URL. All other requests are done on the URL for the API account subdomain.

To become a partner please contact us.

Base API URL

The partner API URL is https://app.makeplans.com/partner/ for production apps and https://app.test.makeplans.net/partner/ for test apps.

Authentication

Use your partner API token. For more info see the main API documentation.

Account

Add new account

POST /clients will create a new client and user.

The initial user is set as admin on the account. The attributes for creation are limited. See API documentation for updating other attributes on the account or to add additional users.

Client Attributes

NameTypeDescription
subdomainStringRequired
emailStringRequired
nameStringRequired
time_zoneStringRequired. See info below.
country_codeStringRequired. ISO 3166-1 alpha-2.
localeStringRequired. Supported locales: 'en', 'sv' and 'nb'. Default: 'en'.
Time zone

Currently a custom time zone naming is used. Please see this list of used names and their mappings.

In the future this will become more standard compliant.

User Attributes

NameTypeDescription
nameStringRequired
emailStringRequired
passwordStringRequired
phone_numberStringAlso available as phonenumber (deprecated).