Invitation

Gets a list of invitations sent by the currently logged in User.

get

Path parameters

strTokenstringRequired

The login token

Responses

200

Success

application/json

get

HTTPcURLJavaScriptPython

GET /api/v2/SentInvitations/{strToken} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "invitations": [
    {
      "invitationID": "text",
      "memoriID": "text",
      "engineMemoriID": "text",
      "isInviter": true,
      "isInvitee": true,
      "text": "text",
      "destinationName": "text",
      "destinationEMail": "text",
      "tag": "text",
      "pin": "text",
      "type": "text",
      "state": "text",
      "creationTimestamp": "2025-06-07T13:56:14.337Z",
      "lastChangeTimestamp": "2025-06-07T13:56:14.337Z"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T13:56:14.337Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets a list of invitations received by the currently logged in User.

get

Path parameters

strTokenstringRequired

The login token

Responses

200

Success

application/json

get

HTTPcURLJavaScriptPython

GET /api/v2/ReceivedInvitations/{strToken} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "invitations": [
    {
      "invitationID": "text",
      "memoriID": "text",
      "engineMemoriID": "text",
      "isInviter": true,
      "isInvitee": true,
      "text": "text",
      "destinationName": "text",
      "destinationEMail": "text",
      "tag": "text",
      "pin": "text",
      "type": "text",
      "state": "text",
      "creationTimestamp": "2025-06-07T13:56:14.337Z",
      "lastChangeTimestamp": "2025-06-07T13:56:14.337Z"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T13:56:14.337Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets a list of invitations sent for the specified Memori object.

get

Access to Invitation objects not belonging to the current logged in user is granted only to administrative users.

Path parameters

strTokenstringRequired

The login token

strMemoriIDstringRequired

The ID of the Memori object

Responses

200

Success

application/json

get

HTTPcURLJavaScriptPython

GET /api/v2/MemoriInvitations/{strToken}/{strMemoriID} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "invitations": [
    {
      "invitationID": "text",
      "memoriID": "text",
      "engineMemoriID": "text",
      "isInviter": true,
      "isInvitee": true,
      "text": "text",
      "destinationName": "text",
      "destinationEMail": "text",
      "tag": "text",
      "pin": "text",
      "type": "text",
      "state": "text",
      "creationTimestamp": "2025-06-07T13:56:14.337Z",
      "lastChangeTimestamp": "2025-06-07T13:56:14.337Z"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T13:56:14.337Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets a list of all Invitation objects.

get

Access to Invitation objects not belonging to the current logged in user is granted only to administrative users.

Path parameters

strTokenstringRequired

The login token

Responses

200

Success

application/json

get

HTTPcURLJavaScriptPython

GET /api/v2/AllInvitations/{strToken} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "invitations": [
    {
      "invitationID": "text",
      "memoriID": "text",
      "engineMemoriID": "text",
      "isInviter": true,
      "isInvitee": true,
      "text": "text",
      "destinationName": "text",
      "destinationEMail": "text",
      "tag": "text",
      "pin": "text",
      "type": "text",
      "state": "text",
      "creationTimestamp": "2025-06-07T13:56:14.337Z",
      "lastChangeTimestamp": "2025-06-07T13:56:14.337Z"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T13:56:14.337Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets the details of an Invitation object of the currently logged in User.

get

Access to Invitation objects not belonging tothe current logged in user is granted only to administrative users.

Path parameters

strTokenstringRequired

The login token

strInvitationIDstringRequired

The ID of the Invitation object

Responses

200

Success

application/json

get

HTTPcURLJavaScriptPython

GET /api/v2/Invitation/{strToken}/{strInvitationID} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "invitation": {
    "invitationID": "text",
    "memoriID": "text",
    "engineMemoriID": "text",
    "isInviter": true,
    "isInvitee": true,
    "text": "text",
    "destinationName": "text",
    "destinationEMail": "text",
    "tag": "text",
    "pin": "text",
    "type": "text",
    "state": "text",
    "creationTimestamp": "2025-06-07T13:56:14.337Z",
    "lastChangeTimestamp": "2025-06-07T13:56:14.337Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T13:56:14.337Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Deletes an existing Invitation object.

delete

Path parameters

strTokenstringRequired

The login token

strInvitationIDstringRequired

The Invitation object ID

Responses

200

Success

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/v2/Invitation/{strToken}/{strInvitationID} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "requestID": 1,
  "requestDateTime": "2025-06-07T13:56:14.337Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Updates an existing Invitation object sent by the currently logged in User.

patch

Path parameters

strTokenstringRequired

The login token

strInvitationIDstringRequired

The Invitation object ID

Body

Specifications of an Invitation object.

invitationIDstring | nullableOptional

ID of this Invitation object. Unique and assigned by the system. Returned during Send and Get operations. Ignored in other cases.

memoriIDstring | nullableOptional

ID of the Memori object this Invitation refers to. Required during Send operations. Returned during Get operations. Ignored in other cases.

engineMemoriIDstring | nullableOptional

ID of the Memori object on the Memori Engine. Returned during Get operations. Ignored in other cases.

isInviterbooleanOptional

True if the requesting User sent this Invitation, and as such has admin (update and delete) access to this Invitation. Returned during Get operations. Ignored in other cases.

isInviteebooleanOptional

True if the requesting User received this Invitation, and as such has accept/reject access to this Invitation. Returned during Get operations. Ignored in other cases.

textstring | nullableOptional

Text of this Invitation. Optional during Send operations. Used in Update operations. Returned during Get operations. Ignored in other cases.

destinationNamestring | nullableOptional

Name of the person to whom this Invitation is addressed. Required during Send operations. Returned during Get operations. Ignored in other cases.

destinationEMailstring | nullableOptional

E-mail address to which this Invitation is addressed. Required during Send operations. Returned during Get operations. Ignored in other cases.

tagstring | nullableOptional

Tag associated with this Invitation. Typically an emoji symbol. Required during Send operations. Returned during Get operations, but visible to invitee only if the invitation has been accepted. Ignored in other cases.

pinstring | nullableOptional

PIN, or personal identification number, associated with this Invitation. Required during Send operations. Returned during Get operations, but visible to invitee only if the invitation has been accepted. Ignored in other cases. Format is six digits integer number, eg. 012345.

typestring | nullableOptional

Type of this Invitation (giver, receiver etc.). Required during Send operations. Returned during Get operations. Ignored in other cases. May be one of the following: GIVER: the Giver is the unique owner, administrator and content manager of a Memori RECEIVER: a Receiver is a named User that can access all the public content of a Memori, plus some specific content targeted specifically at them

statestring | nullableOptional

State of this Invitation (pending, accepted, rejected etc.). Returned during Get operations. Ignored in other cases. May be one of the following: PENDING: the Invitation has just been sent and no action has been perfomed yet ACCEPTED: the destination of this Invitation has accepted it REJECTED: the destination of this Invitation has rejected it

creationTimestampstring · date-time | nullableOptional

Timestamp of creation. Returned during Get operations. Ignored in other cases.

lastChangeTimestampstring · date-time | nullableOptional

Timestamp of latest change. Returned during Get operations. Ignored in other cases.

Responses

200

Success

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/v2/Invitation/{strToken}/{strInvitationID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 315

{
  "invitationID": "text",
  "memoriID": "text",
  "engineMemoriID": "text",
  "isInviter": true,
  "isInvitee": true,
  "text": "text",
  "destinationName": "text",
  "destinationEMail": "text",
  "tag": "text",
  "pin": "text",
  "type": "text",
  "state": "text",
  "creationTimestamp": "2025-06-07T13:56:14.337Z",
  "lastChangeTimestamp": "2025-06-07T13:56:14.337Z"
}

200

Success

{
  "invitation": {
    "invitationID": "text",
    "memoriID": "text",
    "engineMemoriID": "text",
    "isInviter": true,
    "isInvitee": true,
    "text": "text",
    "destinationName": "text",
    "destinationEMail": "text",
    "tag": "text",
    "pin": "text",
    "type": "text",
    "state": "text",
    "creationTimestamp": "2025-06-07T13:56:14.337Z",
    "lastChangeTimestamp": "2025-06-07T13:56:14.337Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T13:56:14.337Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Accepts an Invitation object.

post

Path parameters

strTokenstringRequired

The login token

strInvitationIDstringRequired

The ID of the Invitation object

Responses

200

Success

application/json

post

HTTPcURLJavaScriptPython

POST /api/v2/AcceptInvitation/{strToken}/{strInvitationID} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "invitation": {
    "invitationID": "text",
    "memoriID": "text",
    "engineMemoriID": "text",
    "isInviter": true,
    "isInvitee": true,
    "text": "text",
    "destinationName": "text",
    "destinationEMail": "text",
    "tag": "text",
    "pin": "text",
    "type": "text",
    "state": "text",
    "creationTimestamp": "2025-06-07T13:56:14.337Z",
    "lastChangeTimestamp": "2025-06-07T13:56:14.337Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T13:56:14.337Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Rejects an Invitation object.

post

Path parameters

strTokenstringRequired

The login token

strInvitationIDstringRequired

The ID of the Invitation object

Responses

200

Success

application/json

post

HTTPcURLJavaScriptPython

POST /api/v2/RejectInvitation/{strToken}/{strInvitationID} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "requestID": 1,
  "requestDateTime": "2025-06-07T13:56:14.337Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Sends a new Invitation object.

post

Path parameters

strTokenstringRequired

The login token

Body

Specifications of an Invitation object.

invitationIDstring | nullableOptional

ID of this Invitation object. Unique and assigned by the system. Returned during Send and Get operations. Ignored in other cases.

memoriIDstring | nullableOptional

ID of the Memori object this Invitation refers to. Required during Send operations. Returned during Get operations. Ignored in other cases.

engineMemoriIDstring | nullableOptional

ID of the Memori object on the Memori Engine. Returned during Get operations. Ignored in other cases.

isInviterbooleanOptional

True if the requesting User sent this Invitation, and as such has admin (update and delete) access to this Invitation. Returned during Get operations. Ignored in other cases.

isInviteebooleanOptional

True if the requesting User received this Invitation, and as such has accept/reject access to this Invitation. Returned during Get operations. Ignored in other cases.

textstring | nullableOptional

Text of this Invitation. Optional during Send operations. Used in Update operations. Returned during Get operations. Ignored in other cases.

destinationNamestring | nullableOptional

Name of the person to whom this Invitation is addressed. Required during Send operations. Returned during Get operations. Ignored in other cases.

destinationEMailstring | nullableOptional

E-mail address to which this Invitation is addressed. Required during Send operations. Returned during Get operations. Ignored in other cases.

tagstring | nullableOptional

Tag associated with this Invitation. Typically an emoji symbol. Required during Send operations. Returned during Get operations, but visible to invitee only if the invitation has been accepted. Ignored in other cases.

pinstring | nullableOptional

PIN, or personal identification number, associated with this Invitation. Required during Send operations. Returned during Get operations, but visible to invitee only if the invitation has been accepted. Ignored in other cases. Format is six digits integer number, eg. 012345.

typestring | nullableOptional

Type of this Invitation (giver, receiver etc.). Required during Send operations. Returned during Get operations. Ignored in other cases. May be one of the following: GIVER: the Giver is the unique owner, administrator and content manager of a Memori RECEIVER: a Receiver is a named User that can access all the public content of a Memori, plus some specific content targeted specifically at them

statestring | nullableOptional

State of this Invitation (pending, accepted, rejected etc.). Returned during Get operations. Ignored in other cases. May be one of the following: PENDING: the Invitation has just been sent and no action has been perfomed yet ACCEPTED: the destination of this Invitation has accepted it REJECTED: the destination of this Invitation has rejected it

creationTimestampstring · date-time | nullableOptional

Timestamp of creation. Returned during Get operations. Ignored in other cases.

lastChangeTimestampstring · date-time | nullableOptional

Timestamp of latest change. Returned during Get operations. Ignored in other cases.

Responses

200

Success

application/json

post

HTTPcURLJavaScriptPython

POST /api/v2/SendInvitation/{strToken} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 315

{
  "invitationID": "text",
  "memoriID": "text",
  "engineMemoriID": "text",
  "isInviter": true,
  "isInvitee": true,
  "text": "text",
  "destinationName": "text",
  "destinationEMail": "text",
  "tag": "text",
  "pin": "text",
  "type": "text",
  "state": "text",
  "creationTimestamp": "2025-06-07T13:56:14.337Z",
  "lastChangeTimestamp": "2025-06-07T13:56:14.337Z"
}

200

Success

{
  "invitation": {
    "invitationID": "text",
    "memoriID": "text",
    "engineMemoriID": "text",
    "isInviter": true,
    "isInvitee": true,
    "text": "text",
    "destinationName": "text",
    "destinationEMail": "text",
    "tag": "text",
    "pin": "text",
    "type": "text",
    "state": "text",
    "creationTimestamp": "2025-06-07T13:56:14.337Z",
    "lastChangeTimestamp": "2025-06-07T13:56:14.337Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T13:56:14.337Z",
  "resultCode": 1,
  "resultMessage": "text"
}