Skip to main content
Invites an existing PingBack user to join your organization as an agent or admin. Only the org owner can send invitations. Method: POST URL: /api/v1/team/invite
The person you are inviting must already have a PingBack account. If they do not have one, ask them to sign up at pingback.live first.

Plan limits

PlanMax agents
Free0 (no additional agents)
Mini2
Pro5

Headers

HeaderValue
AuthorizationBearer

Query parameters

email
string
required
Email address of the PingBack user to invite. They must have an existing account.
role
string
default:"agent"
The role to assign. Must be agent or admin. The org owner is always owner and cannot be changed via this endpoint.

Response

message
string
required
Confirmation message indicating the invited user’s role and email.
team_member_id
string
required
UUID of the newly created team membership record.

Example

curl --request POST \
  --url 'https://api.pingback.live/api/v1/team/invite?email=james@acme.com&role=agent' \
  --header 'Authorization: Bearer {token}'

Response example

{
  "message": "Agent james@acme.com invited successfully",
  "team_member_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
}

Assign a conversation

Method: POST URL: /api/v1/team/assign/{conversation_id} Assigns an open conversation to a specific agent. Only admins (org owner or members with the admin role) can assign conversations. The assigned agent receives an instant conversation_assigned Socket.IO event.

Path parameters

conversation_id
string
required
The UUID of the conversation to assign.

Query parameters

agent_id
string
required
The user_id of the team member to assign the conversation to. The agent must be an active member of your organization.

Example

curl --request POST \
  --url 'https://api.pingback.live/api/v1/team/assign/conv-uuid-here?agent_id=agent-user-uuid' \
  --header 'Authorization: Bearer {token}'

Response example

{ "message": "Conversation assigned successfully" }

Errors

StatusMeaning
400User is already a team member, invalid role, or agent is not a team member
401Unauthorized — missing or invalid token
402Plan limit reached — upgrade to add more agents
403Forbidden — only the org owner can invite team members / only admins can assign conversations
404User not found — they must have a PingBack account first / conversation not found