Appearance
Register User
Register users and send invitation emails. Partners call this API to invite users to AddMaple.
Distinct from Create User
This is for partner-initiated signup and invitation. The Create User endpoint serves widget analytics and personalization.
Endpoint: POST https://addmaple.com/api/v1/partner/register
Headers
http
Authorization: Bearer <ADD_MAPLE_API_KEY>
Content-Type: application/json
Idempotency-Key: abc123Idempotency-Key is optional but prevents errors on duplicate calls.
Request Body
json
{
"email": "[email protected]",
"name": "Alice Example",
"partner": "Acme",
"metadata": { "planType": "starter", "note": "any thing" },
"external_ids": [
{ "provider": "account_id", "id": "acct_123" }
]
}metadata– Optional. Any arbitrary JSON to store for the user.external_ids– Optional. IDs to include when reporting back to the partner.
Response: Success (201 Created)
json
{
"success": true,
"userId": "uuid-1234",
"inviteId": "invite-uuid-9876",
"invited": true
}Response: Already Invited (409 Conflict)
json
{
"success": false,
"error": {
"code": "USER_ALREADY_INVITED",
"message": "User already invited.",
"userId": "uuid-1234",
"inviteId": "invite-uuid-9876",
"invite_status": "pending"
}
}Error Responses
- 400 Bad Request – Missing or invalid email.
- 401 Unauthorized – Invalid or missing API key.
Getting Your API Key
Contact [email protected] to become a partner and receive your API key.