PRproject44
Invitations

Invite an entity to join your network.

Create a new invitation for an entity to join your network and provide a requested capability. If an entity identified by the inviteeIdentifiers does not exist in the project44 platform, include relevant contact information for the platform to invite an entity to project44. When an invitation is accepted, a network relationship is formed between the inviter and the invitee.

post/services/invitation/v1/invitations

Request

Request body

capability'TRUCKLOAD_ASSET_TRACKING'

The capability which the invitation will provide.

createdDateTimestring date-time

The datetime when the invitation was created, in ISO-8601 format.

lastModifiedDateTimestring date-time

The datetime when the invitation was last modified, in ISO-8601 format.

status'ACCEPTED' | 'DECLINED' | 'IN_PROGRESS' | 'CANCELLED' | 'EXPIRED'

The current status of the invitation.

Example request

{
  "capability": "TRUCKLOAD_ASSET_TRACKING",
  "createdDateTime": "2023-08-23T10:15:30Z",
  "invitee": {
    "identifiers": [
      {
        "type": "VAT",
        "value": "PL1234567890"
      }
    ]
  },
  "lastModifiedDateTime": "2023-08-23T10:15:30Z",
  "status": "ACCEPTED"
}

Response

Invitation created successfully

capability'TRUCKLOAD_ASSET_TRACKING'

The capability which the invitation will provide.

createdDateTimestring date-time

The datetime when the invitation was created, in ISO-8601 format.

lastModifiedDateTimestring date-time

The datetime when the invitation was last modified, in ISO-8601 format.

status'ACCEPTED' | 'DECLINED' | 'IN_PROGRESS' | 'CANCELLED' | 'EXPIRED'

The current status of the invitation.

Example response

{
  "capability": "TRUCKLOAD_ASSET_TRACKING",
  "createdDateTime": "2023-08-23T10:15:30Z",
  "invitee": {
    "identifiers": [
      {
        "type": "VAT",
        "value": "PL1234567890"
      }
    ]
  },
  "lastModifiedDateTime": "2023-08-23T10:15:30Z",
  "status": "ACCEPTED"
}

Changes

No recorded changes to this operation across all 1 revision of this API.