Record a pickup attempt

Pickup Requests

Authorization

__Secure-guidelab-prod.session_token<token>

Production session cookie set for the guidelab.co domain by Better Auth

In: cookie

Path Parameters

id*string

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

commandId*string

Length1 <= length <= 200

outcome*string

Value in

"collected"
"no_answer"
"not_ready"
"address_issue"
"other"

notes?|

Lengthlength <= 2000

attemptedAt?string

Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}(?::\d{2}(?:\.\d{1,9})?)?(?:Z|[+-]\d{2}:\d{2})$

Response Body

`application/json`

curl -X POST "https://example.com/pickup-requests/string/attempts" \  -H "Content-Type: application/json" \  -d '{    "commandId": "string",    "outcome": "collected"  }'

{  "request": {    "id": "string",    "labId": "string",    "clinicId": "string",    "partnershipId": "string",    "formRevisionId": "string",    "status": "string",    "formData": {      "property1": null,      "property2": null    },    "requestedWindowStart": "string",    "requestedWindowEnd": "string",    "requestedTimezone": "string",    "scheduledWindowStart": "string",    "scheduledWindowEnd": "string",    "scheduledTimezone": "string",    "addressId": "string",    "addressSnapshot": {      "label": "string",      "contactName": "string",      "contactPhone": "string",      "addressLine1": "string",      "addressLine2": "string",      "city": "string",      "state": "string",      "postcode": "string",      "country": "st"    },    "requestedByMemberId": "string",    "assignedMemberId": "string",    "assignedExternalName": "string",    "assignedExternalPhone": "string",    "assignedExternalEmail": "string",    "notes": "string",    "internalNotes": "string",    "collectedAt": "string",    "cancelledAt": "string",    "createdAt": "string",    "updatedAt": "string"  },  "attempt": {    "id": "string",    "attemptNumber": 1,    "outcome": "string",    "notes": "string",    "attemptedAt": "string"  }}

Empty

Schedule, assign, route, collect, reschedule, or cancel a pickup POST

Create a pickup form element POST

Add a new form element to the pickup request form. If no sortOrder is specified, it will be appended at the end. Lab only.