USusepylon
accounts

Update an existing account

Changed on

Updates an existing account by ID or external ID. Only provided fields are modified.

Rate limit: 300 requests per minute

patch/accounts/{id}

Request

  • Base URL
    https://api.usepylon.com
  • URL
    https://api.usepylon.com/accounts/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID or external ID of the account to update.

Request body

account_type'customer' | 'partner'

The type of the account. Can only be changed to "customer" or "partner".

domainsstring[]

Domains of the account. Replaces the account's domains. Must specify one domain as primary.

is_disabledboolean

Whether the account is disabled.

logo_urlstring

Logo URL of the account.

namestring

The name of the account.

owner_idstring

The ID of the owner of the account. If empty string is passed in, the owner will be removed.

primary_domainstring

Must be in the list of domains. If there are any domains, there must be exactly one primary domain.

subaccount_idsstring[]

An array of account IDs to set as this account's subaccounts. If provided, the account's subaccounts become exactly this list; accounts you leave out are detached.

tagsstring[]

An array of strings to use as tags on this account. If provided, the accounts tags will be updated to the given tags.

Example request

{
  "account_type": "customer",
  "channels": [
    {
      "mirror_to": {
        "source": "slack"
      },
      "source": "slack"
    }
  ]
}

Response

request_idstring required

The request ID for tracking.

Example response

{
  "data": {
    "channels": [
      {
        "mirror_to": {
          "source": "slack"
        },
        "source": "slack"
      }
    ],
    "custom_fields": {
      "plan": {
        "value": "enterprise"
      }
    },
    "type": "customer"
  }
}

Changes