Accounts-2 API Reference

Accounts-2

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

`PATCH`
`DELETE`

← Previous page

Update accounts

Required API key scopes

account:write

Path parameters

id
string

Request parameters

name
string
external_id
stringnull
properties
objectnull
tags
array

Response

Example request

PATCH /api/projects/:project_id/accounts/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/accounts/:id/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/accounts/{accounts-2_id}/".format(
        project_id=project_id,
		accounts-2_id="<the accounts-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "external_id": "string",
  "properties": {
    "csm": {
      "id": 0,
      "email": "string"
    },
    "account_executive": {
      "id": 0,
      "email": "string"
    },
    "account_owner": {
      "id": 0,
      "email": "string"
    },
    "stripe_customer_id": "string",
    "hubspot_deal_id": "string",
    "billing_id": "string",
    "sfdc_id": "string",
    "zendesk_id": "string",
    "slack_channel_id": "string",
    "usage_dashboard_link": "string"
  },
  "tags": [
    "string"
  ],
  "notebooks": [
    "string"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": 0,
  "updated_at": "2019-08-24T14:15:22Z"
}

Delete accounts

Required API key scopes

account:write

Path parameters

id
string

Example request

DELETE /api/projects/:project_id/accounts/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/accounts/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/accounts/{accounts-2_id}/".format(
        project_id=project_id,
		accounts-2_id="<the accounts-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

← Previous page

Accounts-2

Endpoints

Update accounts

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete accounts

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Community questions