Sending invitation to contractor

This method allows you to send invi­ta­tion to a com­pa­ny that you have not found on the Plat­form.

Authorization and access

Autho­riza­tion process is described here. Each API request must also con­sist of unique Api-key obtained dur­ing appli­ca­tion reg­is­tra­tion togeth­er with client_id and client_secret.

Url parameters and connection settings

  • URL: https://api.platform.trans.eu
  • End­point: /ex­t/­part­ners-api/v1/­part­ners
  • Http Method: POST

Headers

  • Accept: application/json
  • Con­tent-type: application/json
  • Autho­riza­tion: Bear­er {access_token}
  • Api-key: {unique_ap­p_api-key}

Description and example values

JsonIs requiredExam­pleTypeDescrip­tion
nameYesCom­pa­ny NameStringCom­pa­ny name
given_nameNoAdamStringRecipent first name
family_nameNoKowal­s­kiStringRecipent last name
emailYes123@trans.euStringEmail address to which an invi­ta­tion will be sent

Example request

{
  "name": "Company Name",
  "given_name": "Adam",
  "family_name": "Kowalski",
  "email": "123@trans.eu"
}

Example response

HTTP Code: 200
{
  "message": "Invitation sent"
}