Instance Org Actions

https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID

Below are the various requests that can be performed against the Instance Org resource, as well as the expected parameters and the potential responses.

Delete

Deletes an organization

Method And Url

DELETE https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.User, instanceOrg.*, or instanceOrg.delete.

Request Path Components

Path Component Description Example
INSTANCE_ID ID associated with the instance 575ec8687ae143cd83dc4a97
ORG_ID ID associated with the organization 575ed6e87ae143cd83dc4aa8

Request Headers

Name Required Description Default
Authorization Y The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X DELETE \
    https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID

Successful Responses

Code Type Description
200 Success If organization was successfully deleted

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if organization was not found

Get

Retrieves information on an organization

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.get.

Request Path Components

Path Component Description Example
INSTANCE_ID ID associated with the instance 575ec8687ae143cd83dc4a97
ORG_ID ID associated with the organization 575ed6e87ae143cd83dc4aa8

Request Headers

Name Required Description Default
Authorization Y The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID

Successful Responses

Code Type Description
200 Instance Organization A single organization

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if organization was not found

Patch

Updates information about an organization

Method And Url

PATCH https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.User, instanceOrg.*, or instanceOrg.patch.

Request Path Components

Path Component Description Example
INSTANCE_ID ID associated with the instance 575ec8687ae143cd83dc4a97
ORG_ID ID associated with the organization 575ed6e87ae143cd83dc4aa8

Request Headers

Name Required Description Default
Authorization Y The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Instance Owned Organization Patch schema. For example, the following would be a valid body for this request:

{
  "name": "My Org",
  "limits": {
    "members": 500
  },
  "auditLogEnabled": true
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"name":"My Org","limits":{"members":500},"auditLogEnabled":true}' \
    https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID

Successful Responses

Code Type Description
200 Instance Organization Updated organization information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if organization was not found