GUguesty
User scope

Assign scope

Assigns a scope of permitted properties to a user. Replaces any existing scope. Use assignAll: true to grant access to all properties, or provide specific listingIds.

post/user-scope/assign

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/user-scope/assign
  • Auth
    API key in header authorization

Request body

userIdstring required

User ID

assignAllboolean

Assign all properties to this user. If used, do not provide listingIds.

listingIdsstring[]

Array of specific listing IDs to assign (replaces existing assignments).

Response

Assignment completed successfully

allAssignedboolean

True if all listings in the account are assigned to this user. When true, assignedListingIds will not be present.

assignedListingIdsstring[]

Array of listing IDs that were successfully assigned. Only present when allAssigned is false or undefined. Note: Either allAssigned or assignedListingIds will always be present.

Changes

No recorded changes to this operation across all 2 revisions of this API.