This method allows you to send invitation to a company that you have not found on the Platform.
Authorization and access
Authorization process is described here. Each API request must also consist of unique Api-key obtained during application registration together with client_id and client_secret.
Url parameters and connection settings
- URL: https://api.platform.trans.eu
- Endpoint: /ext/partners-api/v1/partners
- Http Method: POST
Headers
- Accept: application/json
- Content-type: application/json
- Authorization: Bearer {access_token}
- Api-key: {unique_app_api-key}
Description and example values
Json | Is required | Example | Type | Description |
name | Yes | Company Name | String | Company name |
given_name | No | Adam | String | Recipent first name |
family_name | No | Kowalski | String | Recipent last name |
Yes | 123@trans.eu | String | Email address to which an invitation 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"
}