Agencies

Revoke an agency's access

For the owner of a client project: ends an agency's access right away, or declines its open request. What the agency built stays.

delete/agencies/{id}

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/agencies/{id}
  • 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: project:write)

Path parameters

idstring uuid required

The id of the agency relation.

Response

The ended relation.

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.