Generate Invite Code

Generate an invite code

POSThttps://api.dashdoc.eu/api/v4/manager-truckers/{pk}/generate-invite-code/

Response

200

Invite code generated successfully

Body

application/json

pknumber

Dashdoc's internal id.

userUser (object)

phone_numberstring

invite_codestring

Invite code trucker needs to connect to mobile app. The code is generated by Dashdoc.

app_versionnumber

Ignore. Dashdoc technical data.

readable_app_versionstring

Ignore. Dashdoc technical data.

platformstring

Ignore. Dashdoc technical data.

remote_idstring

The ID of the trucker in your system. It has to be unique among all your truckers.

carrierCompany (object)

is_rentedboolean

phone_number_personalstring

addressstring

postcodestring

citystring

country_codecountry (string)

Only the 2-character codification is accepted (ISO 3166-1 alpha-2)

driving_license_numberstring

driving_license_deadlinestring (date-time)

adr_license_deadlinestring (date-time)

carrist_license_deadlinestring (date-time)

occupational_health_visit_deadlinestring (date-time)

new_app_update_availableboolean

Ignore. Dashdoc technical data.

unavailabilityarray of object

List of unavailable period

eventsarray of object

Ignore. Dashdoc technical data.

tagsarray of Tag (object)

List of tags applied to the trucker.

Request

JavaScriptCurl

const response = await fetch('https://api.dashdoc.eu/api/v4/manager-truckers/{pk}/generate-invite-code/', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "pk": 23498,
  "user": {
    "pk": 17293,
    "username": "1b3b4c74-5f07-4f09-b18f-2753ffcf916e",
    "display_name": "Adèle Bouvet",
    "email": "[e-mail]",
    "date_joined": "2024-04-27T13:46:03.280Z",
    "last_login": "2024-04-27T13:46:03.280Z",
    "has_usable_password": true,
    "first_name": "Adèle",
    "last_name": "Bouvet"
  },
  "phone_number": "text",
  "invite_code": "text",
  "app_version": 180,
  "readable_app_version": "2.7.7",
  "platform": "ios",
  "remote_id": "text",
  "carrier": {
    "pk": 928,
    "remote_id": "text",
    "created": "2020-07-30T21:10:06.445510Z",
    "updated": "2020-07-30T21:10:06.44551Z",
    "deleted": false,
    "invoicing_remote_id": "COMP_456",
    "name": "Transport Bouvet",
    "phone_number": "0601020304",
    "email": "[e-mail]",
    "siren": "123456789",
    "trade_number": "text",
    "country": "FR",
    "comments": "text",
    "vat_number": "text",
    "is_verified": false,
    "settings_transport_order_observations": "text",
    "settings_constrain_reference_edition": false,
    "account_type": "text",
    "logo": "text",
    "primary_address": {
      "pk": "text",
      "name": "Transport Bouvet",
      "address": "3 rue des champs",
      "city": "Nantes",
      "postcode": "44000",
      "country": "FR",
      "latitude": -52.5561625,
      "longitude": 92.896504,
      "coords_validated": false,
      "is_demo": false,
      "is_carrier": false,
      "is_shipper": false,
      "is_origin": false,
      "is_destination": false,
      "created_by": 0,
      "created": "2020-07-30T21:10:06.44551Z",
      "instructions": "text",
      "remote_id": "text"
    },
    "managers": [
      {
        "pk": 928,
        "user": {
          "email": "[e-mail]",
          "first_name": "Adèle",
          "last_name": "Bouvet"
        },
        "display_name": "text",
        "role": "text"
      }
    ],
    "has_loggable_managers": false
  },
  "is_rented": false,
  "phone_number_personal": "0601020304",
  "address": "A random address 4 square Dashdoc",
  "postcode": "44000",
  "city": "Nantes",
  "country_code": "FR",
  "driving_license_number": "99 999 999",
  "driving_license_deadline": "2020-12-22T15:31:39.26167Z",
  "adr_license_deadline": "2020-12-22T15:31:39.26167Z",
  "carrist_license_deadline": "2020-12-22T15:31:39.26167Z",
  "occupational_health_visit_deadline": "2020-12-22T15:31:39.26167Z",
  "new_app_update_available": false,
  "unavailability": [],
  "events": [],
  "tags": [
    {
      "pk": 23498,
      "name": "Remorque"
    }
  ]
}