account_relationship_definitions

patch/api/projects/{project_id}/account_relationship_definitions/{id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/account_relationship_definitions/{id}/
  • Auth: HTTP bearer

Path parameters

idstring required
project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

idstring uuid

Relationship definition UUID.

namestring

Human-readable name of the relationship. Unique within the team.

descriptionstring nullable

What this relationship means, e.g. 'The customer success manager responsible for this account'.

is_single_holderboolean

Whether only one user can hold this relationship per account at a time, e.g. a single CSM per account.

is_controlledboolean

Whether customer analytics can take control of this relationship per account. Rows under a controlled relationship can't be deleted. On an account where control has started, only a person can change the relationship and an empty relationship is a deliberate decision. Set by project operators, not through this API.

Response

idstring uuid required

Relationship definition UUID.

namestring required

Human-readable name of the relationship. Unique within the team.

descriptionstring nullable

What this relationship means, e.g. 'The customer success manager responsible for this account'.

is_single_holderboolean

Whether only one user can hold this relationship per account at a time, e.g. a single CSM per account.

is_controlledboolean required

Whether customer analytics can take control of this relationship per account. Rows under a controlled relationship can't be deleted. On an account where control has started, only a person can change the relationship and an empty relationship is a deliberate decision. Set by project operators, not through this API.

Changes

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