LAlatitude-dev
Members

Invite a member

Changed on

Signals an invitation to join the caller's organization. The invitee receives an accept link by email and becomes a member once they accept. The response is the pending invitation record. Requires OAuth authentication (API-key callers can't act on behalf of a specific user). Only organization owners and admins can invite members.

post/v1/members

Request

  • Base URL
    https://api.latitude.so
  • Auth
    HTTP bearer

Request body

emailstring email required

Email address to invite. The invitee receives an accept link by email.

role'owner' | 'admin' | 'member'

Role to grant on acceptance. Defaults to member when omitted.

Response

Invitation created

status'invited' required

Discriminator for pending invitations — the invitee hasn't accepted yet, so no user record exists.

idstring required

Stable invitation identifier. Distinct from membership ids.

organizationIdstring required

Organization the invitation grants access to.

userIdunknown required
role'owner' | 'admin' | 'member' | 'null' nullable required

Role the invitee will get once they accept. null means the default (member).

nameunknown required
emailstring required

Email address the invitation was sent to.

imageunknown required
invitedAtstring required

ISO-8601 timestamp at which the invitation was created.

expiresAtstring required

ISO-8601 timestamp at which the invitation expires.

inviterIdstring required

User id of the member who issued the invitation.

Changes