Agencies

Invite the client to own the project

Invites the client to become the owner of a project in the building stage. The answer always has accept_url, login_email, expires_at and share_text (a short message to paste), so you can send the link yourself by email, WhatsApp or in person. With send_email true (the default) Hypamoon also emails it; with false nothing is emailed (email_sent false). The link works for 14 days and only for a signed-in user with login_email; a client without an account creates one with that address. language (Dutch or English) sets the email and the accept page; the default is your agency's language (Dutch when your company details are in the Netherlands). Inviting again replaces the previous link. Only an owner or builder of your agency gets the link.

post/clients/{id}/owner-invite

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/clients/{id}/owner-invite
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: clients:write)

Path parameters

idstring uuid required

The id of the client project.

Request body

emailstring email required
send_emailboolean
language'nl' | 'en'

Response

The relation with the open invitation, and the link to send.

object'client_relation' required
idstring uuid required
status'pending' | 'active' | 'declined' | 'ended' required
stage'building' | 'client_owned' required
role'viewer' | 'builder' | 'admin' required
max_mode'test' | 'live' required
four_eyesboolean required
payer'client' | 'agency' required
budget_eurnumber nullable required
confirmed_atstring nullable required
ended_atstring nullable required
created_atstring required
ended_via'client' | 'agency' | 'admin' | 'handover' | 'expired' | 'cleanup'
email_sentboolean required
accept_urlstring uri required
login_emailstring email required
expires_atstring required
language'nl' | 'en' required
share_textstring required

Changes

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