---
title: "Invite an entity to join your network."
method: POST
path: "/services/invitation/v1/invitations"
tags: ["Invitations"]
---

# Invite an entity to join your network.

`POST /services/invitation/v1/invitations`

## Request

- Base URL: `https://na12.api.project44.com`
- URL: `https://na12.api.project44.com/services/invitation/v1/invitations`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/api/v4/oauth2/token`
- TypeScript: <https://skmtc.dev/project44/apis/project44-rest-api/docs/services/invitation/v1/invitations/post.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Request body

- Invitation: List of invitations
  - `capability` 'TRUCKLOAD_ASSET_TRACKING': The capability which the invitation will provide.
  - `createdDateTime` string, date-time: The datetime when the invitation was created, in ISO-8601 format.
  - `invitee` Invitee: The entity being invited to provide the capability.
    - `contacts` InvitationContact[]: Contact details of the invitee.
      - `email` string: The email address of the contact.
      - `familyName` string: The family name of the contact (surname, lastname).
      - `givenName` string: The given name of the contact (name, firstname).
      - `locale` string: The locale of the email which will be used to invite the contact, in BCP47 format.
      - `phone` string: The phone number for the contact.
    - `identifiers` InviteeIdentifier[]: The identifiers of the invitee.
      - `type` 'VAT' | 'SCAC' | 'DOT_NUMBER' | 'MC_NUMBER' | 'P44_EU': Invitee identifier type.
      - `value` string: Invitee identifier value.
    - `organization` InvitationOrganization: Organization details of the invitee.
      - `name` string: Organization name.
  - `lastModifiedDateTime` string, 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.

## Response `201`

Invitation created successfully

- Invitation: List of invitations
  - `capability` 'TRUCKLOAD_ASSET_TRACKING': The capability which the invitation will provide.
  - `createdDateTime` string, date-time: The datetime when the invitation was created, in ISO-8601 format.
  - `invitee` Invitee: The entity being invited to provide the capability.
    - `contacts` InvitationContact[]: Contact details of the invitee.
      - `email` string: The email address of the contact.
      - `familyName` string: The family name of the contact (surname, lastname).
      - `givenName` string: The given name of the contact (name, firstname).
      - `locale` string: The locale of the email which will be used to invite the contact, in BCP47 format.
      - `phone` string: The phone number for the contact.
    - `identifiers` InviteeIdentifier[]: The identifiers of the invitee.
      - `type` 'VAT' | 'SCAC' | 'DOT_NUMBER' | 'MC_NUMBER' | 'P44_EU': Invitee identifier type.
      - `value` string: Invitee identifier value.
    - `organization` InvitationOrganization: Organization details of the invitee.
      - `name` string: Organization name.
  - `lastModifiedDateTime` string, 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.

## Other responses

- `400`: Bad request. Malformed or an invalid request
- `404`: Entity not found and no contact information was provided
- `409`: In progress invitation to an entity already exists

---

[API](https://skmtc.dev/project44/apis/project44-rest-api.md) - [All operations](https://skmtc.dev/project44/apis/project44-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/project44/apis/project44-rest-api/revisions/cdf9675e2294?raw)