Agencies

Hand over a client project

Hands over a project in the building stage. With to_email the client becomes the owner after accepting on their own confirmation page; agency_keeps_access says whether your agency keeps working on it (true) or stops (false, then the client pays from then on). With to_agency_project_id another agency takes it over after an owner or builder there accepts in their portal (Clients); your access ends at that moment. A project the client already owns cannot be handed over: the client chooses its agencies. The answer lists open_payments: your payment links and subscriptions for this client, to cancel what should stop.

post/clients/{id}/transfer

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/clients/{id}/transfer
  • 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

to_emailstring email
agency_keeps_accessboolean
to_agency_project_idstring uuid
messagestring

Response

The handover waits for the receiving side.

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'

Changes

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