PRpromorepublic
Location Groups

Create a new LocationGroup

Can be used to create a new LocationGroup

post/location-groups

Request

  • Base URL
    https://workflows.promorepublic.com/webhook/2637089f-b543-45d0-a83e-2334aada4ead/listings/sandbox/api
  • Auth
    HTTP bearer

Request body */*

namestring required

Name (String) of the LocationGroup

status'ACTIVE' | 'DELETED'

Status of the LocationGroup, defaults to "ACTIVE", supported values: ["ACTIVE"].

locationsinteger[]

List of location IDs (Long) that shall be assigned to the new LocationGroup.

usersinteger[]

List of user IDs (Long) that shall be assigned to the new LocationGroup.

Response

LocationGroup created successfully

status'SUCCESS' | 'PENDING' | 'QUOTA_LIMIT_EXCEED' | 'NOT_AUTHORIZED' | 'FORBIDDEN' | 'BAD_ACCESS_TOKEN' | 'BAD_PRIVATE_KEY' | 'BAD_PUBLIC_KEY' | 'MISSING_PARAMETER' | 'INVALID_PARAMETER' | 'WRONG_PARAMETER_TYPE' | 'CONFLICT' | 'RESOURCE_LOCKED' | 'SERVER_ERROR' | 'ERROR' | 'NOT_FOUND' | 'BAD_REQUEST' | 'USER_ERROR' | 'PARTIAL_ERROR' | 'SERVICE_TEMPORARILY_UNAVAILABLE' required
messagestring

(optional) Holds further information about the response

warningsstring[]

(optional) Holds further warnings

Example response

{
  "response": {
    "locations": [
      {
        "id": 1,
        "name": "Location 1",
        "status": "ACTIVE"
      }
    ],
    "users": [
      {
        "id": 1,
        "email": "jane.doe@example.com",
        "firstName": "Jan",
        "lastName": "Didschuneit",
        "role": "ADMIN",
        "status": "VERIFIED"
      }
    ]
  }
}

Changes

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