Skip to content

Team

Add or invite a member

If the email already belongs to a whatsappx.si account, that person is added immediately and the response is a member. Otherwise a pending invite is created (valid for 7 days) and emailed when email is configured; the response then includes invite_url. Only owners can add admins.

POST/api/v1/members
  • Console only: owner or admin
  • Workspace: X-Tenant-ID

Headers

  • Cookiestringrequired

    The whatsappx_session cookie the app sets when you sign in. Browsers send it automatically; API keys are not accepted on this endpoint.

    Example
    whatsappx_session=…
  • X-Tenant-IDuuidrequired

    Workspace id. Required for session requests. You can pass ?tenant=<id> instead.

    Example
    8d0f6c2e-3b1a-4c55-9a7e-2f4b6d1e9c30

Body

application/json
  • emailstringrequired

    Email address of the person to add.

    Example
    alex@example.com
  • roleenumrequired

    admin or agent.

    Example
    agent

Response

201 Createdapplication/json

  • iduuid

    Invite id.

  • emailstring

    Invited email address (lower case).

  • roleenum

    admin or agent.

  • statusstring

    Invite status, pending while it can be accepted.

  • expires_atinteger

    Expiry in Unix seconds (7 days after it was sent).

  • invite_urlstringmay be absent

    Link the invitee opens to join. Returned when an invite is created or resent.

  • email_sentboolean

    Whether the invite email was sent.

  • createdboolean

    true for an invite (as opposed to a member added immediately).

Status codes

  • 201Created. Either a member (existing account, added now) or an invite (created: true).
  • 400Bad request. enter a valid email address, role must be admin or agent, user is already a member, an invite is already pending for this email or invalid request.
  • 401Unauthorized. No signed-in session (unauthorized).
  • 403Forbidden. API keys can never call this endpoint (API keys cannot administer workspaces). A signed-in user who is not an owner or admin gets admin required; a user who is not a member of the workspace gets forbidden. Admins who try to add an admin get only owners can add admins.

When the person already has an account, the 201 body is a member object instead: id, user_id, email, name, role.