APG PayAPG Paydocs

Enterprises

Update enterprise

PATCH/enterprises/{enterpriseId}

Add or replace a public encryption key for the enterprise, give or replace its registration, set its branding, or set the hosts it serves. One operation per request. An enterprise's own credential may do all but the last for its own enterprise; claiming hosts is the platform's alone.

4 actionsEntUpdateBrandingEntUpdateEncryptionKeyEntUpdateRegistrationEntUpdateSites

Permissions

Required permission
enterprises:update

Requires the `update` action on `enterprises` for the supplied runtime context

Path parameters

enterpriseIdstring
required

Request body

This body is a typed union. Pick a variant to see its fields and a matching example.

Discriminated by type
type = "EntUpdateBranding"

How an enterprise's sites look, and what the dashboards beneath it fall back to where a merchant or marketplace sets nothing of its own. Every field is optional.

curl -X PATCH https://api.tst.au.apgpay.dev/enterprises/{enterpriseId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "EntUpdateBranding",
  "branding": {
    "type": "EntBrandingAttributes",
    "displayName": "Ada Lovelace",
    "companyName": "Ada Lovelace",
    "supportEmail": "ada@example.com",
    "website": "string",
    "logoUri": "https://example.com/callback",
    "logoDarkUri": "https://example.com/callback",
    "iconUri": "https://example.com/callback",
    "logoAltText": "string",
    "primaryColor": "string",
    "primaryColorDark": "string"
  }
}'

Responses

The response is a tagged shape: type is always "EntUpdateRspAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "EntUpdateRspAttributes"

The resource as it stands after the change.

Example
{
  "type": "EntUpdateRspAttributes",
  "updated": {
    "type": "EntViewAttributes",
    "enterpriseId": "ent_9f2Kd8QpLzXw",
    "slug": "string",
    "businessName": "Ada Lovelace",
    "status": "Enabled",
    "website": "string",
    "companyEmail": "ada@example.com",
    "companyPhone": "+61400000000",
    "encryptionKeyNames": [
      "Ada Lovelace"
    ],
    "registration": {
      "type": "EntRegistrationAttributes",
      "country": "AU",
      "businessRegistrationNumber": "string",
      "taxRegistrationNumber": "string",
      "registeredAddress": {
        "type": "MchtAddressAttributes",
        "unitNumber": "string",
        "streetNumber": "string",
        "streetName": "Ada Lovelace",
        "streetType": "string",
        "suburb": "string",
        "city": "string",
        "state": "string",
        "postalCode": "3000",
        "country": "AU"
      }
    },
    "branding": {
      "type": "EntBrandingAttributes",
      "displayName": "Ada Lovelace",
      "companyName": "Ada Lovelace",
      "supportEmail": "ada@example.com",
      "website": "string",
      "logoUri": "https://example.com/callback",
      "logoDarkUri": "https://example.com/callback",
      "iconUri": "https://example.com/callback",
      "logoAltText": "string",
      "primaryColor": "string",
      "primaryColorDark": "string"
    },
    "sites": [
      {
        "type": "EntSiteAttributes",
        "domain": "string",
        "app": {
          "type": "EntSiteAppDashboard"
        }
      }
    ],
    "createdAt": "2026-08-19T04:21:07Z",
    "updatedAt": "2026-08-19T04:21:07Z"
  }
}

Error responses