Add/Remove App member

POST /apps/{id}/members
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/apps/{id}/members

Add/Remove member to/from an App

path Parameters
Arrow
Name
Description
idstringrequired
Unique identifier for the object defined as a path parameter.


Example: 12345
Request Body Schema
Arrow
Name
Description
company_idstring
A unique company identifier generated by the Ocamba platform.


Example: 1000000
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
emailstring (email)
Member email address.


Example: [email protected]
idstring
A unique identifier generated by the Ocamba platform.


Example: 1000163
imagestring (url)
The image of the member.


Example: https://image-uri-example.com
namestring
Name of the member.


Example: John Doe
preferencesobject

Name
Description
generalgeneral-setting
General settings object.
General Settings
Name
Description
currencystring
Currency which will be applied to all Ocamba platform transactions.


Example: EUR
date_formatstring
Date format which will be applied to the overall Ocamba UI.


Example: DD-MM-YYYY
first_week_daystring
First day of week which will be applied to the overall Ocamba UI.


Example: mon
number_formatobject

Name
Description
decimal_separatorstring
Separator represented as comma.


Example: ,
thousand_separatorstring
Separator represented as dot.


Example: .
themestring
Theme which will be applied to the overall Ocamba UI.


Example: light
time_formatstring
Time format which will be applied to the overall Ocamba UI.


Example: 24
timezoneinteger
Time zone which will be applied to the overall Ocamba UI.


Example: 1
securitysecurity-setting
Security settings object.
Security Settings
Name
Description
country_restrictions[ string ]
Array of countries allowed to access to the Ocamba platform.
ip_restrictions[ string ]
Array of unique IP addresses allowed to access to the Ocamba platform. Only IPv4 format is supported.
statusstring
Describe member status.


Example: active

Possible values: active | suspended

Default: active
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
Response status codes
Arrow
201 - Created
Arrow
Request examples
Copied
Arrow
add Arrow
  • add
  • remove
{
  "add": ["1234567", "7654321"]
}

{
  "remove": ["7654321"]
}