Bulk Update Organizations

This endpoint updates the Organization fields specified in the body for multiple Organizations at once.

Request

To update one or more specific attributes of one or more Organization(s) please make a PATCH request to the following URL:

HTTP MethodURL
PATCHhttps://industrial.api.ubidots.com/api/v2.0/organizations/_/bulk/update/

Query Parameters

ParameterTypeUseDescription
tokenStringAuthenticationAuthentication Token can optionally be sent as a query parameter.

Body Parameters

The body is an Array containing Organization JSON objects. Each Organization object can contain the following any of the following body parameters:

ParameterTypeRequired?Default ValueDescription
idStringYesN/A (required)The id of the organization desired to be updated
labelStringNo""The API label of Organization
nameStringNoSame as labelName of the Organization
descriptionStringNo""Description of Organization
faviconStringNonullIcon of Organization. How to update the favicon
logoStringNonullLogo of Organization. How to update the logo
propertiesObjectNo{}Organization properties
isActiveBooleanNoTrueIs True when Organization is active
app<app_key>NonullKey of App (id or label)

Header

ParameterRequired?Description
X-Auth-TokenYesAuthentication Token of account
X-Bulk-OperationYesNeed to be set to True for the bulk operation to work
Content-TypeYesContent type of body
$ curl -X PATCH
'https://industrial.api.ubidots.com/api/v2.0/organizations/_/bulk/update/' \
 -H 'Content-Type: application/json' \
 -H 'X-Auth-Token: oaXBo6ODhIjPsusNRPUGIK4d72bc73' \
 -H 'X-Bulk-Operation: True' \
 -d '[
  {
    "id": "409dba9c67d3bb19f554",
    "name": "Organization Third"
  },
  {
    "id": "4923b1670068c9c54b06",
    "name": "Organization Fourth"
  },
  {
    "id": "445da83878abc3c75756",
    "name": "Organization Fifth"
  }
]'
{
  "task": {
    "id": "4974ac3a88301c016192"
  }
}
{
    "code": 400001,
    "message": "Validation Error.",
    "detail": {
        ....
    }
}
{
    "code": 401001,
    "message": "Authentication credentials were not provided.",
    "detail": "Authentication credentials were not provided."
}
{
    "detail": "Header `X-BULK-OPERATION` should be provided for bulk operation."
}

Response

Returns a Task Id of the asynchronous process.