Instance Member Actions

https://api.losant.com/instances/INSTANCE_ID/members/USER_ID

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

Delete

Deletes an instance member

Method And Url

DELETE https://api.losant.com/instances/INSTANCE_ID/members/USER_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, instanceMember.*, or instanceMember.delete.

Request Path Components

Path Component Description Example
INSTANCE_ID ID associated with the instance 575ec8687ae143cd83dc4a97
USER_ID ID associated with the instance member 575ec8687ae143cd83dc4a94

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/members/USER_ID

Successful Responses

Code Type Description
200 Success If member was successfully deleted

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if instance or member was not found

Get

Returns an instance member

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/members/USER_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, instanceMember.*, or instanceMember.get.

Request Path Components

Path Component Description Example
INSTANCE_ID ID associated with the instance 575ec8687ae143cd83dc4a97
USER_ID ID associated with the instance member 575ec8687ae143cd83dc4a94

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/members/USER_ID

Successful Responses

Code Type Description
200 Instance Member A single instance member

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if instance or member was not found

Patch

Modifies the role of an instance member

Method And Url

PATCH https://api.losant.com/instances/INSTANCE_ID/members/USER_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, instanceMember.*, or instanceMember.patch.

Request Path Components

Path Component Description Example
INSTANCE_ID ID associated with the instance 575ec8687ae143cd83dc4a97
USER_ID ID associated with the instance member 575ec8687ae143cd83dc4a94

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 Member Patch schema. For example, the following would be a valid body for this request:

{
  "role": "view"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"role":"view"}' \
    https://api.losant.com/instances/INSTANCE_ID/members/USER_ID

Successful Responses

Code Type Description
200 Instance Member Patch The modified instance member

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if instance or member was not found