Pular para o conteúdo

Update a sub-tenant

Updates the branding of an existing sub-tenant — logo, primary and secondary colors, and fonts. All body fields are optional: send only the ones you want to change. To change the list of allowed redirect domains, use Add a redirect domain instead.

PATCH/api/v1/sub-tenants

Update a sub-tenant

Partially updates the branding of an existing sub-tenant identified by the subTenantId query parameter.

Auth: Bearer Token

Parâmetros de query

1 campo
subTenantId●
querystring

Business identifier of the sub-tenant to update.

Corpo da requisição

5 campos
urlLogo
bodystring

New URL of the sub-tenant logo.

primaryColor
bodystring

New primary brand color (hex).

secondaryColor
bodystring

New secondary brand color (hex).

urlFont
bodystring

New URL of the custom font file.

nameFont
bodystring

New font family name.

curl --request PATCH \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/sub-tenants?subTenantId=subTenant123' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --data '{
  "urlLogo": "http://example.com/logo.png",
  "primaryColor": "#000000",
  "secondaryColor": "#FFFFFF",
  "urlFont": "http://example.com/font.ttf",
  "nameFont": "Arial"
}'

Response

200Sub-tenant updated successfully.
Response body
object
  • dataobjectrequired

    Full sub-tenant record after the update.

    • idstringrequired

      Internal ID of the sub-tenant.

    • namestringrequired

      Name of the sub-tenant.

    • subTenantIdstringrequired

      Business identifier of the sub-tenant.

    • eppIamClientIdstringrequired

      IAM client ID used by this sub-tenant.

    • urlLogostringrequired

      URL of the sub-tenant logo.

    • primaryColorstringrequired

      Primary brand color (hex).

    • secondaryColorstringrequired

      Secondary brand color (hex).

    • urlFontstringrequired

      URL of the sub-tenant font file.

    • nameFontstringrequired

      Font family name.

    • tenantobjectrequired

      Parent tenant this sub-tenant belongs to.

    • domainsarray of stringrequired

      Redirect domains currently allowed for this sub-tenant.

  • messagestring

    Response message.

  • typestring

    Response type. One of `error`, `warning`, `info`, `success`.

  • statusCodeinteger· nullable

    HTTP status code carried inside the envelope.

200 · Sub-tenant updated successfully.
{
  "data": {
    "id": "subTenant123",
    "name": "SubTenant A",
    "subTenantId": "subTenant123",
    "eppIamClientId": "eppClient123",
    "urlLogo": "http://example.com/logo.png",
    "primaryColor": "#000000",
    "secondaryColor": "#FFFFFF",
    "urlFont": "http://example.com/font.ttf",
    "nameFont": "Arial",
    "tenant": {
      "tenantId": "tenant123",
      "name": "Tenant A",
      "rpIamClientId": "rpClient123"
    },
    "domains": [
      "app.example.com.br"
    ]
  },
  "message": "Sub-tenant updated successfully.",
  "type": "success",
  "statusCode": 200
}

Next steps