WOworkramp

Update Allowed Email Domains

Updates the list of allowed email domains that users can use to register. This endpoint overwrites the list, if you need to add or remove individual domains use the POST or DELETE endpoints. Send an empty list to remove all existing domains.

put/api/v1/academies/{academy_id}/email_domains

Request

  • Base URL
    https://app.workramp.com
  • URL
    https://app.workramp.com/api/v1/academies/{academy_id}/email_domains
  • Auth
    API key in header Authorization

Path parameters

academy_idstring required

The id of the Academy

Headers

Content-Typestring

Request body

email_domainsstring[] required

The list of allowed domains that users can use to register.

Response

200

emailDomainsAllowedstring[]
emailDomainsAllowedEnabledboolean
emailDomainsBlockedEnabledboolean

Example response

{
  "emailDomainsAllowed": [
    "google.com"
  ],
  "emailDomainsAllowedEnabled": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.