This endpoint updates the Organization fields specified in the body.
Request
To update one or more specific attributes of an Organization please make a PATCH request to the following URL:
| HTTP Method | URL |
|---|---|
| PATCH | https://industrial.api.ubidots.com/api/v2.0/organizations/<organization_key>/ |
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| organization_key | String | The id or label of the Organization, label should use the prefix ~ |
Query Parameters
| Parameter | Type | Use | Description |
|---|---|---|---|
| token | String | Authentication | Authentication Token can optionally be sent as a query parameter. |
Body Parameters
| Parameter | Type | Required? | Description |
|---|---|---|---|
| label | String | No | The API label of Organization |
| name | String | No | Name of the Organization |
| description | String | No | Description of Organization |
| favicon | Image File | No | Icon of Organization. How to update the favicon |
| logo | Image File | No | Logo of Organization. How to update the logo |
| properties | Object | No | Organization properties |
| isActive | Boolean | No | Is True when Organization is active |
| app | <app_key> | No | Key of App (id or label) |
Updating
faviconandlogoOur backend is that powerful that it can handle files. There is however one little caveat, the data needs to be sent as
form-data. Practically this means simply a different flag in the curl. And important to know, you can send the other attributes asform-datatoo. There is an example on the right hand side.
curl -X PATCH 'https://industrial.api.ubidots.com/api/v2.0/organizations/<organization_key>' \ -H 'X-Auth-Token: oaXBo6ODhIjPsusNRPUGIK4d72bc73' \ -F 'favicon=path/logo.png' -F 'logo=@logoname'
Header
| Parameter | Required? | Description |
|---|---|---|
| X-Auth-Token | Yes | Authentication Token of account |
$ curl -X PATCH 'https://industrial.api.ubidots.com/api/v2.0/organizations/<organization_key>' \
-H 'Content-Type: application/json' \
-H 'X-Auth-Token: oaXBo6ODhIjPsusNRPUGIK4d72bc73' \
-d '{
"label": "variable2",
"name": "Variable 2",
"description": "my variable 2",
"tags": ["blue", "yellow"],
"properties": {}
}'
{
"app": null,
"createdAt": "2020-01-01T14:05:55.471155Z",
"description": "Other Organization",
"devicesCount": 0,
"favicon": null,
"id": "435ab418805c32fa400f",
"isActive": true,
"label": "my-second-customer",
"limits": [
{
"actual_value": 0,
"icon": "hdd-o",
"max_value": "*",
"name": "Devices",
"type": "devices"
},
{
"actual_value": 0,
"icon": "envelope",
"max_value": "*",
"name": "Emails",
"type": "emails"
},
{
"actual_value": 0,
"icon": "signal",
"max_value": "*",
"name": "Variables",
"type": "variables"
},
{
"actual_value": 0,
"icon": "users",
"max_value": "*",
"name": "Users",
"type": "users"
},
{
"actual_value": 0,
"icon": "spinner",
"max_value": "*",
"name": "Dots",
"type": "dots"
},
{
"actual_value": 0,
"icon": "mobile-phone",
"max_value": "*",
"name": "SMS",
"type": "sms"
},
{
"actual_value": 0,
"icon": null,
"max_value": "*",
"name": "Voice",
"type": "voice"
}
],
"logo": null,
"name": "My Best Customer",
"properties": {"any": "thing"},
"url": "https://industrial.api.ubidots.com/api/v2.0/organizations/435ab418805c32fa400f",
"usersCount": 0
}
{
"code": 400001,
"message": "Validation Error.",
"detail": {
....
}
}
{
"code": 401001,
"message": "Authentication credentials were not provided.",
"detail": "Authentication credentials were not provided."
}
Response
Returns an Organization object of the updated Organization.