Invite

Invite a contact

POSThttps://api.dashdoc.eu/api/v4/contacts/{uid}/invite/

Path parameters

uid*string

Response

200

Invite successful

Body

application/json

uidstring (uuid)

Example: "687cddac-dbd2-11ea-9024-0242ac130006"

createdcreated (string (date-time))

Date of creation on our server

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

companyCompany (object)

first_namestring

Example: "Adèle"

last_namestring

Example: "Bouvet"

emailstring (email)

Example: "[e-mail]"

phone_numberstring

Example: "[phone]"

fax_numberstring

remote_idstring

The id of the contact in your system

Example: "CONTACT_123"

is_managerboolean

Ignore. Dashdoc technical data.

has_pending_inviteboolean

Ignore. Dashdoc technical data.

is_invitableboolean

Ignore. Dashdoc technical data.

invitation_linknullable string (url)

Request

JavaScriptCurlPython

const response = await fetch('https://api.dashdoc.eu/api/v4/contacts/{uid}/invite/', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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": 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
  },
  "first_name": "Adèle",
  "last_name": "Bouvet",
  "email": "[e-mail]",
  "phone_number": "[phone]",
  "fax_number": "text",
  "remote_id": "CONTACT_123",
  "is_manager": false,
  "has_pending_invite": false,
  "is_invitable": false,
  "invitation_link": "text"
}