Invite

Invite a contact

post

Authorizations

ApiKeyAuth

AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"

Path parameters

uidstringRequired

Responses

200

Invite successful

application/json

uidstring · uuidOptionalExample: 687cddac-dbd2-11ea-9024-0242ac130006

createdstring · date-timeOptional

Date of creation on our server

Example: 2020-12-22T15:31:39.26167Z

first_namestringOptionalExample: Adèle

last_namestringOptionalExample: Bouvet

emailstring · emailOptionalExample: [e-mail]

phone_numberstringOptionalExample: [phone]

fax_numberstringOptional

remote_idstringOptional

The id of the contact in your system

Example: CONTACT_123

is_managerbooleanOptional

Ignore. Dashdoc technical data.

has_pending_invitebooleanOptional

Ignore. Dashdoc technical data.

is_invitablebooleanOptional

Ignore. Dashdoc technical data.

invitation_linkstring · url · nullableOptional

post/contacts/{uid}/invite/

HTTPcURLJavaScriptPython

POST /api/v4/contacts/{uid}/invite/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*

200

Invite successful

{
  "uid": "687cddac-dbd2-11ea-9024-0242ac130006",
  "created": "2020-12-22T15:31:39.26167Z",
  "company": {
    "pk": 928,
    "remote_id": "text",
    "created": "2020-07-30T21:10:06.445510Z",
    "updated": "2020-07-30T21:10:06.44551Z",
    "deleted": true,
    "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": true,
    "settings_transport_order_observations": "text",
    "settings_constrain_reference_edition": true,
    "account_type": "text",
    "logo": "text",
    "subscription_access": {},
    "settings": {},
    "primary_address": {
      "pk": 23498,
      "name": "Transport Bouvet",
      "address": "3 rue des champs",
      "city": "Nantes",
      "postcode": "44000",
      "country": "FR",
      "latitude": -52.5561625,
      "longitude": 92.896504,
      "radius": 500,
      "coords_validated": false,
      "is_demo": true,
      "is_carrier": true,
      "is_shipper": true,
      "is_origin": true,
      "is_destination": true,
      "created_by": {
        "pk": 25,
        "name": "Transport Bouvet"
      },
      "created_by_user": {
        "pk": 34,
        "display_name": "Jean Pierre Bouvet",
        "company": 25,
        "trucker_id": 95
      },
      "created": "2020-12-22T15:31:39.26167Z",
      "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": true
  },
  "first_name": "Adèle",
  "last_name": "Bouvet",
  "email": "[e-mail]",
  "phone_number": "[phone]",
  "fax_number": "text",
  "remote_id": "CONTACT_123",
  "is_manager": true,
  "has_pending_invite": true,
  "is_invitable": true,
  "invitation_link": "text"
}