Create a guest invite for a lead

POST /api/v1/leads/{leadId}/guest-invites

Error

A valid request URL is required to generate request examples

201

{
  "ok": "<unknown>",
  "meta": {
    "requestId": "<string>",
    "serverTime": "2023-11-07T05:31:56Z"
  },
  "data": {
    "invite": {
      "id": "<string>",
      "dbId": 123,
      "leadId": "<string>",
      "email": "<string>",
      "status": "pending",
      "expiresAt": "2023-11-07T05:31:56Z",
      "acceptedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "token": "<string>"
  }
}

Path Parameters

leadId · string · required

Minimum string length: 1

Body

application/json

email · string · required

Minimum string length: 1

permissions · object · required

Show child attributes

expiresAt · string<date-time> | null · required

Response

201

application/json

Created

ok · any · required

meta · object · required

Show child attributes

data · object · required

Show child attributes