Create Request

POST /di/collection-request/

Properties

Property	Description
`templateId`	Form Id under which the request is created
`childAccountId`	Child account under which the request is created
`minimumParticipants`	Minimum number of participants required
`maximumParticipants`	Maximum number of participants allowed
`participantList`	List of invited participants
`webhookUrl`	URL to receive status change notifications
`webhookSecret`	Secret used to verify webhook signatures
`webhookIdentifier`	(Optional) Custom identifier included in webhook payloads

Body

CreateCollectionRequestDto {
  templateId: string;
  childAccountId: string;
  minimumParticipants: number;
  maximumParticipants: number;
  participantList: ParticipantDetails[];
  webhookUrl: string;
  webhookSecret: string;
  webhookIdentifier: string;
}

ParticipantDetails

ParticipantDetails {
  email: string;
  phoneNumber: string;
  name: string;
  isAdmin: boolean;
}

Example request

curl --request POST 'https://api.qidpro.xyz/di/collection-request/' \
  --header 'Authorization: Bearer your-secret-key' \
  --header 'tokenId: your-token-id' \
  --header 'Content-Type: application/json' \
  --data '{
    "templateId": "68f3c241c222712d98c925c5",
    "childAccountId": "65df6943fdfc8d36890575d7",
    "minimumParticipants": 1,
    "maximumParticipants": 5,
    "participantList": [
      {
        "email": "[email protected]",
        "phoneNumber": "919876543210",
        "name": "Guest User",
        "isAdmin": true
      }
    ],
    "webhookUrl": "https://your-server.com/webhooks/qid",
    "webhookSecret": "your-webhook-secret",
    "webhookIdentifier": "hotel_checkin_123"
  }'

Guest check-in URL

After creating a collection request, share the guest check-in link with participants. Replace :requestId with the _id returned from the create response.

Environment	Guest check-in URL
Production	`https://collect.oneqid.com/request/:requestId`
Staging	`https://devcollect.oneqid.com/request/:requestId`

Example (production):

https://collect.oneqid.com/request/69ae919d383217210dca57a8