invitations

A viewset for managing organization invitations.

post/invitations{format}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid

Path parameters

format'.json' required

Headers

X-Organization-Idstring

Selects the active organization for this request. Optional for callers that belong to exactly one active organization — the single membership is resolved implicitly. Required when the caller has two or more active memberships; omitting it in that case returns 400. If the header names an organization the caller is not an active member of, the server returns 403.

Request body

idinteger required
emailstring email required
first_namestring
last_namestring
organizationinteger required
invited_byinteger nullable required
accepted_atstring date-time nullable required
expires_atstring date-time required
createdstring date-time required
modifiedstring date-time required

Response

idinteger required
emailstring email required
first_namestring
last_namestring
organizationinteger required
invited_byinteger nullable required
accepted_atstring date-time nullable required
expires_atstring date-time required
createdstring date-time required
modifiedstring date-time required

Changes

    • ○

      added the non-success response with the status

    • ▲

      the response property became nullable for the status

    • ○

      the request property became nullable (media type: application/json)

    • ○

      the request property became nullable (media type: application/x-www-form-urlencoded)

    • ○

      the request property became nullable (media type: multipart/form-data)