Accounts & connections · Account Groups

Create group

Creates a group.

POSThttps://api.pozy.ai/v1/account-groups
createAccountGroup

Guide: Account groups

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication

Request body

application/json, required

  • namestringrequired
  • accountIdsarray of stringrequired
  • profileIdstringdeprecated

Example

curl -X POST "https://api.pozy.ai/v1/account-groups" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "accountIds": [
    "string"
  ]
}'

Response

201 on success

  • messagestring
  • groupobject
    • _idstring
    • namestring
    • accountIdsarray of string
201 response
{
  "message": "Hello from Pozy",
  "group": {
    "_id": "635d87e261ae344ef27fd1df",
    "name": "Acme",
    "accountIds": [
      "string"
    ]
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Account Groups