Agencies

Ask a client for access to their project

Asks the owner of an existing project for access. The answer has confirm_url: a page in the portal where the owner sees what your agency can do, who pays and how to revoke, and accepts or declines. With payer agency your agency offers to pay the usage; the owner can still choose to pay himself. Nothing is emailed; give the link to the client. An open request is returned as it is (200).

post/clients/access-requests

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/clients/access-requests
  • 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)

Request body

project_idstring uuid required
messagestring
payer'client' | 'agency'

Response

The open request or active relation that already existed.

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'
confirm_urlstring uri required

Changes

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