Members

Set brand access

PATCH/v1/workspaces/{workspaceId}/members/{userId}/brand-access

Limit a member to some brands, or give every brand back. For them and their API keys, other brands don't exist: they aren't listed and answer 404. Brands they create join their list. See Brand access. The owner always sees every brand, so limiting the owner fails with 409 owner_has_every_brand. Only the workspace owner can do this, and only from the app. See Owner-only and app-only.

curl -X PATCH "$AYEFORM_API/v1/workspaces/$WORKSPACE_ID/members/$USER_ID/brand-access" \
  -H "Authorization: Bearer $AYEFORM_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "brandIds": [
      "BRAND_ID"
    ]
  }'

200 Response

{
  "userId": "tjkfq4cpgb1c6746gmaw2gyd67qvn2hj",
  "email": "orders@luigispizza.com",
  "name": "Luigi's Pizza",
  "role": "owner",
  "brandIds": [
    "khs69yxwyr7kw03m5j1v7qmhdvknj6ac"
  ],
  "otherBrands": false,
  "keysGoOnRemoval": false
}

Path parameters

workspaceIdstringrequired
The workspace's id. An API key can only use its own workspace.
userIdstringrequired
The member.

Body

JSON, with Content-Type: application/json.

brandIdsarray of string or nullrequired
The brands this member may see, at least one. Send null to give every brand back, which always works. Limiting needs per-brand access, which is on the Agencies plan; other plans get 403 plan_feature.

Response

userIdstringrequired
emailstringrequired
namestring or nullrequired
roleenumrequired
One of "owner", "member"
brandIdsarray of string or nullrequired
The only brands this member sees, or null when they see every brand. Set it with PATCH /v1/workspaces/{workspaceId}/members/{userId}/brand-access. If you are limited to some brands yourself, this lists only brands you also see.
otherBrandsbooleanrequired
True when every brand this member is limited to is one you don't see.
keysGoOnRemovalbooleanrequired
True when the member is limited to some brands. Removing such a member also revokes their API keys.

Errors answer with a status and the error shape.