API Reference
Contact Us

Updating properties of an Entity.

patch
https://gateway-am.apps.ins.inswhub.com/entities/1.2/entities/

This endpoint allows updating certain properties of an Entity. If all operations can be executed, then PATCH will be executed. Otherwise, it will fail. 'entityId', 'entityStatus' and 'lockReason' cannot be modified. Credentials in 'user' property can be changed in their corresponding endpoints.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique ID of the Entity.

Body Params

It is the body of the patch to alter a single property of the resource identified as path.

Headers
date-time

Header parameter that informs the date and time when the message was originated. It is used for basic message integrity checks, to ensure that the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.

string

Header parameter to uniquely identifies the request. Must be supplied as an UUID.

string
length ≤ 256

String containing the channel used to originate the request. For example USSD, Web, App.

string

It is used to send the pre-shared client API key to the server.

string
required

It is used to send the user’s access token when OAuth 2.0/OIDC authorization framework is used for end-user authentication.

uri

URL supplied by the client that will be used to return the callback in the form of an HTTP PUT.

Responses
204

This response is returned if all operations were successfully executed.

Updated 4 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago