Vendors

Invite a vendor to their portal

Generates a fresh password for the vendor's portal account, emails them an invite with it, and stamps lastPortalInvite. The new password is also returned to you. A vendor with no email address cannot be invited. Requires the vendors:write permission.

POST

https://services.magicdoor.com/maintenance/company-portal/vendors/{vendorId}/portal-invite

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

vendorIdstringrequired

The vendor to act on. A Snowflake id, sent as a decimal string.

example: 1826110384726355968

Response

200 · The invite was sent.

newPasswordstringrequired

The password that was generated and emailed to the vendor. Any password they had before no longer works.

400 · The vendor has no email address, so there is nowhere to send the invite.

401 · The request carried no valid access token.

403 · The token is not a property manager token, or it lacks the `vendors:write` permission.

404 · No such vendor, or it belongs to another company.

Request

curl --request POST \
  --url 'https://services.magicdoor.com/maintenance/company-portal/vendors/1826110384726355968/portal-invite' \
  --header 'Authorization: Bearer <token>'

Response

{
  "newPassword": "brisk-harbor-4417"
}