STstreampay
Organization

Create Invite For A User To Join The Organization By Email

Changed on

Send an email invitation for a user to join the organization.

An invitation email will be sent to the specified address with a link to accept the invitation. The caller can invite to the whole organization only as an organization admin, and to a branch only where they hold members:write.

post/api/v2/organization/invite

Request

  • Base URL
    https://stream-app-service.streampay.sa
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Headers

language'AR' | 'EN'

Request body

emailstring email required

Email address of the user to invite. May already be registered; rejected only if they are already a member of this organization.

Response

Successful Response

idstring uuid
emailstring email
organization_idstring uuid
expire_atstring date-time
created_bystring uuid

Changes

  • bb23366f1a76Revision changes
    • breaking

      added the new required request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

  • 9a960de24945Revision changes
    • breaking

      the language request header's property undefined was restricted to a list of enum values

    • breaking

      the header request parameter language was restricted to a list of enum values

    • breaking

      for the header request parameter language, default value was changed from ar to AR

    • info

      added the new enum value AR to the header request parameter language

    • info

      added the new enum value EN to the header request parameter language