v1

latestSwagger 2.02026-07-13107214235.7 KB

Workgroup

Update a specific Workgroup

put/v1/workgroups/{workgroup_id}/detail

Path parameters

workgroup_idstring required

Request body

address_line1string

address_line2string

address_line3string

citystring

countrystring

decimal_placesinteger

postalstring

statestring

workgroup_namestring

Example request

{
  "address_line1": "sample address_line1",
  "address_line2": "sample address_line2",
  "address_line3": "sample address_line3",
  "city": "sample city",
  "country": "sample country",
  "custom_fields": [
    {
      "param_name": "sample param_name",
      "string_value": "sample string_value"
    }
  ],
  "postal": "sample postal",
  "state": "sample state",
  "workgroup_name": "sample workgroup_name"
}

Response

Successful updated

status_codeinteger

status_reasonstring

workgroup_idinteger

workgroup_namestring

Example response

{
  "status_reason": "sample status_reason",
  "workgroup_name": "sample workgroup_name"
}