Create Invite

POST /invites
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/invites

Creates a new Invite object

Request Body Schema
Arrow
Name
Description
accessobject
Key value pair of app_id(key) and role_id(value).


Example: { "1010": "1107" }
company_idstring
A unique identifier generated by the Ocamba platform.


Example: 1000163
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
idstring
A unique identifier generated by the Ocamba platform.


Example: 423
invite_timedateTime
Inviting time, Timezone: GMT.


Example: 2021-07-30 12:50:13
inviteestring
Email address of the person invited to Ocamba platform.


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


Example: 1123163
messagestring
Optional message sent to user invited to Ocamba.


Example: some message
namestring
Name of the person invited to Ocamba platform.


Example: John Doe
statusstring
Describes invitation status.


Example: expired
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
Response status codes
Arrow
201 - Created
Arrow
Request examples
Copied
Arrow
200 Arrow
  • 200
{
  "invitee": "[email protected]",
  "message": "only for testing"
}
Response examples
Copied
Arrow
201 Arrow
  • 201
{
  "id": "295",
  "company_id": "6345624",
  "inviter_id": "1000077",
  "access": {
      "1010": "1107"
  },
  "invitee": "[email protected]",
  "name": "john.doe",
  "message": "only for testing",
  "status": "pending"
}