Skip to main content

Invite an Organization

POST 
/v1/organizations/invite

Invites an organization to register on the BidZenith platform. An organization administrator receives instructions to complete registration of the organization, and is able to subsequently invite other users to the organization.

Request​

Body

The request received from the client.

    name stringrequired

    The name of the Organization.

    administratorEmail stringrequired

    The email of the user to make an administrator for the Organization.

    timeZone string

    (Optional) An IANA time zone database identifier corresponding to the time zone for date and time related properties e.g. "Australia/Sydney". If unspecified, defaults to "Australia/Sydney".

    culture string

    (Optional) A culture (locale) in a format "languagecode2-country/regioncode2" e.g. "en-US". The culture determines the formatting for dates and numbers. If unspecified, defaults to "en-AU".

Responses​

OK

Schema

    organization

    object

    required

    An Organization.

    organizationId stringrequired

    The Organization identifier.

    name stringrequired

    The name of the Organization.

    timeZone stringrequired

    An IANA time zone database identifier corresponding to the time zone for date and time related properties e.g. "Australia/Sydney".

    culture stringrequired

    A culture (locale) in a format "languagecode2-country/regioncode2" e.g. "en-US". The culture determines the formatting for dates and numbers.

    timestamp date-timerequired

    A timestamp of when the organization was invited.

Loading...