Team-API #

Ditt team är alla som arbetar i ditt konto förutom du själv — administratörer, agenter och läsbehöriga användare — plus de inbjudningar du har skickat och de avdelningar du har organiserat dem i. Team-API:et är den programmatiska versionen av Inställningar → Team: lägg till och ta bort personer, ställ in vad var och en kan se och göra, skicka och påminna om inbjudningar samt hantera avdelningar.

Alla slutpunkter nedan är relativa till bas-URL:en https://api.youraiconnector.com/v1. För dashboard-versionen av allt på denna sida, se Teamhantering.

Autentisering: dessa slutpunkter kräver en inloggad person #

Detta är den enda delen av API:et som en API-nyckel inte kan använda. Varje /team-slutpunkt förutom avdelnings-slutpunkterna måste anropas med en Firebase ID-token från en inloggad session:

Authorization: Bearer <Firebase ID token>

Skicka en API-nyckel istället så avvisas begäran med ett 401:

{
  "success": false,
  "error_code": 401,
  "error": "This endpoint requires a Firebase ID token (Authorization: Bearer <token>)."
}

Anledningen är att dessa slutpunkter fattar beslut baserat på vem som är inloggad: din roll, taket för vad du får bevilja någon annan, och om du för närvarande arbetar i ett annat konto. En API-nyckel är en integration, inte en person, så det finns ingen som dessa regler kan tillämpas på.

I praktiken innebär det att Team-API:et är till för en förstapartsapp med en inloggad Your AI Connector-användare (se Autentisering → Firebase ID-token). En server-till-server-integration kan inte hantera teammedlemmar — det finns inget sätt att skapa en av dessa tokens utanför appen.

Undantaget: de fyra avdelnings-slutpunkterna är vanliga API-slutpunkter. De accepterar din API-nyckel precis som resten av API:et, såväl som en inloggad session.

Varje svar på denna sida följer det vanliga kuvertet: success: true plus slutpunktens fält på toppnivå, eller success: false med error och error_code när något går fel.

Roller och behörigheter #

Varje teammedlem har en roll, som anger deras standardåtkomst över 12 områden i appen. Du kan sedan åsidosätta enskilda områden.

Varje område är inställt på en av fyra nivåer: none (dolt), view (skrivskyddat), edit (skapa och ändra), full (inklusive borttagning).

För att avvika från rollens standardvärden, skicka permission_overrides — en array av { "area": ..., "level": ... }-objekt. Varje post ersätter rollens standardvärde för just det området; allt du inte listar behåller rollens standardvärde.

"permission_overrides": [
  { "area": "analytics", "level": "full" },
  { "area": "billing", "level": "none" }
]

Vem kan anropa dessa slutpunkter

• Kontoinnehavaren kan alltid göra allt.
• En teammedlem behöver team_management på view för att läsa medlemslistan och inbjudningslistan, och på edit för att lägga till, ändra, inaktivera, ta bort, bjuda in, avbryta eller skicka om. Administratörer har edit som standard; redigerare och läsare har none, så som standard är det endast administratörer som kan hantera teamet.
• Ingen kan bevilja högre åtkomst än sin egen. Om du försöker ge någon en nivå som du inte själv innehar — eller redigera, inaktivera eller ta bort någon vars åtkomst redan är bredare än din — nekas begäran med 403 och ett meddelande som anger området.

Teammedlemsobjektet #

GET /team/members returnerar ett av dessa per medlem:

Borttagna medlemmar returneras inte — listan innehåller endast aktiva och inaktiverade medlemmar.

Synlighetsbegränsningar är endast skrivbara här. contact_scope, contact_scope_axes och sub_account_access (se Begränsa vad en medlem kan se) kan ställas in vid skapande, uppdatering och inbjudan, men denna slutpunkt returnerar dem inte.

Lista teammedlemmar #

GET /team/members

Returnerar medlemslistan plus din plans platsantal, så att du kan visa “3 av 5 platser” och veta när en inbjudan är på väg att nekas.

cURL

curl "https://api.youraiconnector.com/v1/team/members" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN"

JavaScript

const res = await fetch("https://api.youraiconnector.com/v1/team/members", {
  headers: { Authorization: `Bearer ${idToken}` },
});
const { members, seat_limit, seats_used } = await res.json();

Python

import requests

res = requests.get(
    "https://api.youraiconnector.com/v1/team/members",
    headers={"Authorization": f"Bearer {id_token}"},
)
data = res.json()

Svar

{
  "success": true,
  "members": [
    {
      "account_owner_uid": "owner_uid_123",
      "member_uid": "uid_alice",
      "member_email": "alice@example.com",
      "member_display_name": "Alice Chen",
      "role": "admin",
      "permission_overrides": [],
      "status": "active",
      "auto_assign_enabled": true,
      "created_by": "owner_uid_123",
      "created_at": "2026-05-01T10:00:00.000Z",
      "updated_at": "2026-06-02T09:15:00.000Z"
    }
  ],
  "seat_limit": 5,
  "seats_used": 3
}

seat_limit är null när din plan inte har något platsantal. seats_used räknar endast aktiva medlemmar — att inaktivera eller ta bort någon frigör deras plats omedelbart.

Lägg till en teammedlem direkt #

POST /team/members

Lägger till någon i ditt team direkt, utan en inbjudan.

Detta skickar inget e-postmeddelande. Ingen meddelas om att de har lagts till, och om de inte redan hade en Your AI Connector-inloggning har kontot som skapats för dem inget lösenord, så de kan inte logga in förrän de återställer det. Använd Skicka en inbjudan såvida du inte har ett eget sätt att informera personen och hjälpa dem att logga in.

Begäransfält

cURL

curl -X POST "https://api.youraiconnector.com/v1/team/members" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "sam@example.com",
    "display_name": "Sam Rivera",
    "role": "editor"
  }'

JavaScript

const res = await fetch("https://api.youraiconnector.com/v1/team/members", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${idToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    email: "sam@example.com",
    display_name: "Sam Rivera",
    role: "editor",
  }),
});
const { member_uid } = await res.json();

Svar — 201 Created

{
  "success": true,
  "team_member_id": "owner_uid_123_uid_sam",
  "member_uid": "uid_sam",
  "message": "Team member created successfully."
}

Att lägga till någon som tidigare var avstängd eller borttagen återaktiverar dem istället för att misslyckas.

Uppdatera en teammedlem #

PATCH /team/members/{memberUid}

Ändrar en medlems roll, behörigheter, synlighet, klientåtkomst eller om de deltar i automatisk kontakttilldelning. Skicka endast de fält du vill ändra; allt du utelämnar behåller sitt nuvarande värde.

Begäransfält

Detta är den enda endpointen där null betyder “rensa”. Att skicka "contact_scope": null, "contact_scope_axes": null eller "sub_account_access": null tar bort den begränsningen helt och återställer medlemmen till att se allt. Vid skapande och inbjudan betyder null helt enkelt “ej angivet”.

cURL

curl -X PATCH "https://api.youraiconnector.com/v1/team/members/uid_sam" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "role": "admin",
    "permission_overrides": [{ "area": "billing", "level": "none" }]
  }'

Svar

{
  "success": true,
  "message": "Team member updated successfully."
}

Stäng av en teammedlem #

POST /team/members/{memberUid}/suspend

Stänger av någon: de behåller sin plats i teamet men förlorar åtkomst. Använd detta istället för att ta bort när pausen är tillfällig — ta tillbaka dem med PATCH /team/members/{memberUid} och {"status": "active"}.

cURL

curl -X POST "https://api.youraiconnector.com/v1/team/members/uid_sam/suspend" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN"

Svar

{
  "success": true,
  "message": "Team member suspended successfully."
}

En avstängd medlem frigör sin plats, så att du kan bjuda in någon annan i deras ställe. Deras åtkomst upphör när deras nuvarande sessionstoken nästa gång uppdateras, vilket kan ta upp till en timme — ta bort dem istället om du behöver att det sker omedelbart.

Ta bort en teammedlem #

DELETE /team/members/{memberUid}

Tar bort en person från ditt team och frigör deras plats. De loggas ut och förlorar åtkomst till ditt konto; deras egen inloggning förblir orörd.

cURL

curl -X DELETE "https://api.youraiconnector.com/v1/team/members/uid_sam" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN"

Svar

{
  "success": true,
  "message": "Team member removed successfully."
}

Borttagningen är permanent från din sida: en borttagen medlem kan inte återaktiveras via uppdateringsslutpunkten — bjud in dem igen om du ändrar dig. Deras e-postadress tas även bort från kontots aviseringslista.

Begränsa vad en medlem kan se #

Tre valfria fält, som accepteras vid lägg till, uppdatera och bjuda in, avgör hur mycket av kontot en person ser. De staplas: en medlem som är begränsad på mer än ett sätt begränsas av alla.

contact_scope — all (standard: alla kontakter och konversationer) eller assigned (endast de som tilldelats dem). Med assigned, lägg till "contact_scope_unassigned": true för att även låta dem se kontakter som ingen äger ännu.

contact_scope_axes — begränsar dem till namngivna agenter, kanaler eller avdelningar:

Agent- och avdelnings-ID:n kontrolleras inte när du sparar dem — ett ID som inte existerar matchar helt enkelt ingenting, vilket visas som en tom inkorg istället för ett fel. Kanalnamn kontrolleras: ett okänt namn avvisas med 400.

Inget av dessa tre kan ställas in på kontots ägare — den begäran nekas med 400.

Lista inbjudningar #

GET /team/invites

De inbjudningar du har skickat, sorterade med de nyaste först, så att du kan se vem som ännu inte har accepterat.

Frågeparametrar

cURL

curl "https://api.youraiconnector.com/v1/team/invites?status=pending" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN"

Svar

{
  "success": true,
  "invites": [
    {
      "id": "inv_abc123",
      "account_owner_uid": "owner_uid_123",
      "account_owner_display_name": "Acme Ltd",
      "invitee_email": "sam@example.com",
      "invitee_uid": null,
      "role": "editor",
      "permission_overrides": [],
      "status": "pending",
      "created_by": "owner_uid_123",
      "created_at": "2026-06-10T12:00:00.000Z",
      "expires_at": "2026-06-17T12:00:00.000Z",
      "responded_at": null
    }
  ]
}

Inbjudningstoken returneras aldrig — den finns bara i e-postmeddelandet som skickades.

Skicka en inbjudan #

POST /team/invites

Skickar en inbjudan via e-post till någon att gå med i ditt team. Detta är det vanliga sättet att lägga till en teammedlem: de klickar på länken, loggar in som sig själva och accepterar. Om de inte har ett Your AI Connector-konto ännu skapas ett åt dem, och e-postmeddelandet guidar dem genom att ställa in ett lösenord.

Begäransfält

Genom att ställa in behörigheter i förväg behöver du inte redigera medlemmen efteråt — allt kopieras till deras medlemskap när de accepterar.

cURL

curl -X POST "https://api.youraiconnector.com/v1/team/invites" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "email": "sam@example.com", "role": "editor" }'

JavaScript

const res = await fetch("https://api.youraiconnector.com/v1/team/invites", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${idToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ email: "sam@example.com", role: "editor" }),
});
const { invite_id } = await res.json();

Svar — 201 Created

{
  "success": true,
  "invite_id": "inv_abc123",
  "message": "Team invite sent successfully."
}

Saker att planera för

• Inbjudningar går ut efter 7 dagar. En utgången inbjudan kan skickas på nytt, vilket startar en ny 7-dagarsperiod.
• Väntande inbjudningar upptar en plats. Till skillnad från att lägga till en medlem direkt, räknar platskontrollen här aktiva medlemmar plus väntande inbjudningar, så ett konto där alla platser är upptagna nekas innan e-postmeddelandet skickas.
• 20 inbjudningar per dag, räknat per konto för både utskick och återskick.

Avbryt en inbjudan #

DELETE /team/invites/{inviteId}

Drar tillbaka en inbjudan innan den har accepterats. Länken i e-postmeddelandet slutar fungera.

cURL

curl -X DELETE "https://api.youraiconnector.com/v1/team/invites/inv_abc123" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN"

Svar

{
  "success": true,
  "message": "Team invite cancelled."
}

Både pending- och expired-inbjudningar kan avbrytas. En inbjudan som redan har accepterats, avböjts eller avbrutits returnerar 400; en som inte är din returnerar 403; ett okänt ID returnerar 404.

Skicka inbjudan på nytt #

POST /team/invites/{inviteId}/resend

Skickar inbjudningsmeddelandet igen — för när det missades eller hamnade i skräpposten. Fungerar på pending- och expired-inbjudningar och återställer utgångstiden till 7 dagar från nu.

cURL

curl -X POST "https://api.youraiconnector.com/v1/team/invites/inv_abc123/resend" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN"

Svar

{
  "success": true,
  "message": "Team invite resent successfully."
}

Det nya e-postmeddelandet innehåller en ny länk, och den gamla länken fortsätter också att fungera, så en person som hittar det första e-postmeddelandet senare blir inte stående utan åtkomst. Att skicka på nytt räknas mot samma gräns på 20 per dag som att skicka, och att återaktivera en utgången inbjudan kontrollerar dina platser på nytt — en full plan nekas med 429.

Acceptera en inbjudan #

POST /team/invites/accept

Accepterar en inbjudan med token från inbjudningsmeddelandet och lägger till den inloggade personen i det kontots team.

Detta är en handling som utförs av din egen identitet. Logga in som dig själv — det nekas avsiktligt med 403 medan du arbetar inuti någon annans konto.

Begäransfält

cURL

curl -X POST "https://api.youraiconnector.com/v1/team/invites/accept" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "invite_token": "1f4c…" }'

Svar

{
  "success": true,
  "team_member_id": "owner_uid_123_uid_sam",
  "account_owner_uid": "owner_uid_123",
  "message": "Team invite accepted successfully."
}

Avböj en inbjudan #

POST /team/invites/decline

Avböjer en inbjudan med token från e-postmeddelandet. Precis som vid godkännande är detta en handling som utförs av din egen identitet och nekas medan du arbetar inuti ett annat konto.

cURL

curl -X POST "https://api.youraiconnector.com/v1/team/invites/decline" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "invite_token": "1f4c…" }'

Svar

{
  "success": true,
  "message": "Team invite declined."
}

Avdelningar #

En avdelning är en namngiven grupp i ditt team — Försäljning, Kundsupport, HR. Den ger en lead ett ägande team, kan själv ta hand om nya konversationer och kan användas för att begränsa vad en medlem ser.

Dessa fyra slutpunkter kräver en API-nyckel. Till skillnad från resten av den här sidan autentiseras de som alla andra slutpunkter i API:et (se Autentisering). En inloggad session fungerar också: läsning kräver contacts vid view, och att skapa, ändra eller ta bort kräver team_management vid edit.

Avdelningsobjektet

När både routing_agents och routing_channels är inställda måste en konversation matcha båda för att arkiveras här — det är så du ger ett team “supportagenten, men bara på WhatsApp”.

Ett konto kan ha upp till 50 avdelningar.

Lista avdelningar #

GET /team/departments

curl "https://api.youraiconnector.com/v1/team/departments?apiKey=YOUR_API_KEY"

Svar

{
  "success": true,
  "departments": [
    {
      "id": "dep_abc123",
      "name": "Sales",
      "color": "#2f6fed",
      "member_uids": ["uid_alice", "uid_bob"],
      "auto_assign_enabled": true,
      "routing_agents": [],
      "routing_channels": ["whatsapp"],
      "created_by": "owner_uid_123"
    }
  ]
}

Skapa en avdelning #

POST /team/departments

Begäransfält

cURL

curl -X POST "https://api.youraiconnector.com/v1/team/departments?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sales",
    "color": "#2f6fed",
    "member_uids": ["uid_alice", "uid_bob"],
    "routing_channels": ["whatsapp"]
  }'

JavaScript

const res = await fetch("https://api.youraiconnector.com/v1/team/departments", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Sales",
    color: "#2f6fed",
    member_uids: ["uid_alice", "uid_bob"],
    routing_channels: ["whatsapp"],
  }),
});
const { department } = await res.json();

Python

import requests

res = requests.post(
    "https://api.youraiconnector.com/v1/team/departments",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={
        "name": "Sales",
        "color": "#2f6fed",
        "member_uids": ["uid_alice", "uid_bob"],
        "routing_channels": ["whatsapp"],
    },
)
department = res.json()["department"]

Svar — 201 Created

{
  "success": true,
  "department": {
    "id": "dep_abc123",
    "name": "Sales",
    "color": "#2f6fed",
    "member_uids": ["uid_alice", "uid_bob"],
    "auto_assign_enabled": true,
    "routing_agents": [],
    "routing_channels": ["whatsapp"],
    "created_by": "owner_uid_123"
  }
}

Uppdatera en avdelning #

PATCH /team/departments/{departmentId}

Ändrar en avdelning. Endast de fält du skickar ändras.

curl -X PATCH "https://api.youraiconnector.com/v1/team/departments/dep_abc123?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "member_uids": ["uid_alice"], "auto_assign_enabled": false }'

Svar

{
  "success": true,
  "department": {
    "id": "dep_abc123",
    "name": "Sales",
    "color": "#2f6fed",
    "member_uids": ["uid_alice"],
    "auto_assign_enabled": false,
    "routing_agents": [],
    "routing_channels": ["whatsapp"],
    "created_by": "owner_uid_123"
  }
}

Om inga kända fält skickas returneras 400; en okänd avdelning returnerar 404; ett namn som krockar med en annan avdelning returnerar 409.

Ta bort en avdelning #

DELETE /team/departments/{departmentId}

curl -X DELETE "https://api.youraiconnector.com/v1/team/departments/dep_abc123?apiKey=YOUR_API_KEY"

Svar

{
  "success": true,
  "deleted": "dep_abc123"
}

Det går inte att ta bort en avdelning som någon är begränsad till. Svaret 400 anger de medlemmar vars synlighet är begränsad till den, så att du kan ändra deras omfattning först. Detta är avsiktligt: att tyst ta bort begränsningen skulle ge dem tillgång till hela din kundbas utan att det märks.

Kontakter som sorterats under en borttagen avdelning skrivs inte om — de slutar helt enkelt visa en avdelning, och nästa gång du sorterar dem kommer det att fungera.

Kontrollera dina egna behörigheter #

GET /team/permissions

Returnerar vad den inloggade personen har tillåtelse att göra i det konto de för närvarande arbetar i. Använd detta för att dölja knappar som en medlem inte kan använda, istället för att låta dem upptäcka begränsningen genom ett felmeddelande.

cURL

curl "https://api.youraiconnector.com/v1/team/permissions" \
  -H "Authorization: Bearer FIREBASE_ID_TOKEN"

Svar — kontoinnehavaren

{
  "success": true,
  "role": "owner",
  "is_team_mode": false,
  "permissions": {
    "campaigns": "full",
    "contacts": "full",
    "messages": "full",
    "appointments": "full",
    "settings": "full",
    "billing": "full",
    "team_management": "full",
    "analytics": "full",
    "phone_numbers": "full",
    "integrations": "full",
    "faqs": "full",
    "daily_summaries": "full"
  }
}

Svar — en teammedlem som arbetar i ett konto

{
  "success": true,
  "role": "editor",
  "is_team_mode": true,
  "permissions": { "campaigns": "edit", "billing": "none", "…": "…" },
  "member": {
    "uid": "uid_sam",
    "email": "sam@example.com",
    "display_name": "Sam Rivera",
    "account_owner_uid": "owner_uid_123"
  }
}

role är owner när den inloggade personen är kontoinnehavaren; annars är det deras teamroll. member finns endast i teamläge och innehåller contact_scope, contact_scope_unassigned och contact_scope_axes när deras medlemskap har dessa.

Sessions-tokens #

Fem slutpunkter skapar en engångs-inloggningstoken för att växla mellan konton. De svarar alla på samma sätt:

{
  "success": true,
  "customToken": "eyJhbGciOi…"
}

Token byts ut mot en session med Firebase-klientens SDK. Det är inte en API-nyckel och kan inte skickas som en sådan, vilket är anledningen till att dessa slutpunkter endast är användbara i en förstapartsapp.

Var och en nekar med 403 när sessionen inte har rätt till det: inte medlem i det kontot, inte personal, underkontot tillhör inte din byrå eller har inte beviljats dig, eller så är sessionen för närvarande inte i det läge som slutpunkten kräver.

Tilldela en plattformsroll #

POST /team/users/{targetUid}/role

Ställer in en användares plattformsroll — User, Dev, Support eller Agency. Detta är inte ett teammedlemskap: det är vilken typ av Your AI Connector-konto någon har.

Denna slutpunkt är begränsad till Your AI Connector-personal, och den sista kvarvarande Dev kan inte nedgraderas. Listad för fullständighet; den är inte en del av att hantera ditt eget team.

{
  "success": true,
  "targetUid": "uid_sam",
  "role": "Agency",
  "claimUpdated": true
}

Team API-fel #

Team-slutpunkter returnerar standardfel-kuvertet, alltid med error_code tillsammans med HTTP-statusen:

{
  "success": false,
  "error_code": 403,
  "error": "Cannot grant \"full\" access to \"billing\" — exceeds your own permissions."
}

De delade koderna som varje slutpunkt kan returnera — 429 (hastighetsgräns) och 500 — listas med vägledning för återförsök i Fel & Sidnumrering.

Relaterat #

• Teamhantering — samma funktioner i instrumentpanelen, med skärmdumpar.
• Autentisering — hur man skickar en Firebase ID-token istället för en API-nyckel.
• Kontakter API — de kontakter som en medlems synlighetsbegränsningar gäller för.