• /
  • Log in
  • Free account

Partnership API sub-account object

This doc explains how to use the Partnership API to manage sub-accounts. For accounts, you'd use the sub-account object.

Requirements

You may not have access to using this object. Before using the Partnership API, first read the requirements.

Introduction to using sub-accounts

Some notes about using the sub-account object:

  • To manage existing master accounts or existing sub-accounts, use the Partnership API account object.
  • A parent account may have more than one associated sub-account, but every sub-account must correspond to one and only one parent account.
  • Every sub-account must have at least a primary_admin user.
  • You cannot create a sub-account without connecting it to an existing parent account and adding at least one user.

Sub-account object attributes

Before using the Partnership API, first read the requirements.

Here are the Partnership API sub-account object's attributes:

For some New Relic organizations, sub-accounts can also be created via the master account's Account settings page in the New Relic UI.

Sub-account API calls

Here is the URL pattern to create sub-accounts. Notice that the Parent Account ID must be specified. If using this URL pattern, send the JSON object along with an HTTP header containing the Partner API key. For example:

POST .../api/v2/partners/PARTNER_ID/accounts/PARENT_ACCOUNT_ID/sub_accounts​
x-api-key:PARTNER_ACCOUNT_KEY
Content-Type: application/json

{ JSON data }

Call

Resource URL pattern

Create a sub-account with the given parameters.

POST /api/v2/partners/PARTNER_ID/accounts/PARENT_ACCOUNT_ID/sub_accounts

JSON example

Here is an example of a JSON request and response using the Partnership API sub-account object.

Note that this is just an example, and that for some accounts, the users attribute is unnecessary and will be ignored.

Sub-account object API examples

Here is an example of an API call using the Partnership API sub-account object.

Note that this is just an example, and that for some accounts, the users attribute is unnecessary and will be ignored.

For more help

If you need more help, check out these support and learning resources:

Create issueEdit page
Copyright © 2021 New Relic Inc.