For the complete documentation index, see llms.txt. This page is also available as Markdown.

Draft

Beta: Create a draft slot

post

Create a new draft slot for a specific site. The slot will be created in draft state without a zone or scheduled times.

Draft slots allow you to:

  • Pre-register a booking before scheduling
  • Add notes and references
  • Include custom fields
Authorizations
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
site-slugstringRequired

The slug identifier of the site

Body
notestring · nullableOptional

Optional note for the slot (can be blank or null)

Responses
201

Draft slot created successfully

application/json
uidstringRequired

Unique identifier for the slot

start_timestring · date-time · nullableOptional

Start time of the slot in ISO 8601 format (null for draft slots until scheduled)

end_timestring · date-time · nullableOptional

End time of the slot in ISO 8601 format (null for draft slots until scheduled)

statestring · enumRequired

State of the slot (always "draft" for draft slots)

Possible values:
notestring · nullableOptional

Optional note for the slot

post/flow/sites/{site-slug}/slots/draft/
POST /api/v4/flow/sites/{site-slug}/slots/draft/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "company": {
    "remote_id": "COMP789"
  }
}
{
  "uid": "550e8400-e29b-41d4-a716-446655440000",
  "company": {
    "pk": 123,
    "remote_id": "COMP789",
    "name": "Acme Corporation"
  },
  "state": "draft",
  "note": "Special delivery instructions",
  "fields": {
    "references": [
      "ORDER123",
      "SHIPMENT456"
    ],
    "Order Number": "12345",
    "Delivery Instructions": "Use back door"
  }
}

Last updated

Was this helpful?