Create for entity

POST

https://api.sureshake.com/v2/entities/{entityId}/engagement-invitations

Path parameters

entityId
string
required
format: uuid

Request body JSON

Any of the following:

object
- relationshipId
  string
  required
  format: uuid
- targetLabel
  string
  required
  maxLength: 200 · minLength: 1
- idempotencyKey
  string
  required
  format: uuid
- kind
  meeting
  required
- meetingUrl
  string
  required
  format: uri
- message
  optional
  string
  maxLength: 2000 · minLength: 1
- scheduledAt
  optional
  string
  format: date-time
}
object
- relationshipId
  string
  required
  format: uuid
- targetLabel
  string
  required
  maxLength: 200 · minLength: 1
- idempotencyKey
  string
  required
  format: uuid
- kind
  report
  required
- reportId
  string
  required
  format: uuid
- message
  optional
  string
  maxLength: 2000 · minLength: 1
}
object
- relationshipId
  string
  required
  format: uuid
- targetLabel
  string
  required
  maxLength: 200 · minLength: 1
- idempotencyKey
  string
  required
  format: uuid
- kind
  capital_objective
  required
- capitalObjectiveId
  string
  required
  format: uuid
- message
  optional
  string
  maxLength: 2000 · minLength: 1
}

Returns

201

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- startupListingId
  string
  required
  format: uuid
- relationshipId
  string
  required
  format: uuid
- recipientPrincipal
  object
  required
  type
  user
  or
  entity
  or
  organization
  required
  id
  string
  required
  minLength: 1
- recipientUserIds
  array of
  string
  required
  minLength: 1
- kind
  meeting
  or
  report
  or
  capital_objective
  required
- targetLabel
  string
  required
  maxLength: 200 · minLength: 1
- message
  string
  or null
  required
  maxLength: 2000 · minLength: 1
- meetingUrl
  string
  or null
  required
  format: uri
- scheduledAt
  string
  or null
  required
  format: date-time
- reportId
  string
  or null
  required
  format: uuid
- capitalObjectiveId
  string
  or null
  required
  format: uuid
- status
  sent
  or
  cancelled
  required
- invitedByUserId
  string
  required
  minLength: 1
- createdAt
  string
  required
  format: date-time
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Create for entity

curl --request POST \
  --url 'https://api.sureshake.com/v2/entities/<entityId>/engagement-invitations' \
  --header 'Content-Type: application/json' \
  --data '
{
  "relationshipId": "928dd5b8-3ead-4528-bdef-9c0b867a5d7d",
  "targetLabel": "string",
  "message": "string",
  "idempotencyKey": "0c14c6a6-6f50-4d1e-b0c4-b46ff43ba6a1",
  "kind": "meeting",
  "meetingUrl": "http://example.com",
  "scheduledAt": "2019-08-24T14:15:22Z"
}
'

const url = 'https://api.sureshake.com/v2/entities/<entityId>/engagement-invitations';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    relationshipId: '928dd5b8-3ead-4528-bdef-9c0b867a5d7d',
    targetLabel: 'string',
    message: 'string',
    idempotencyKey: '0c14c6a6-6f50-4d1e-b0c4-b46ff43ba6a1',
    kind: 'meeting',
    meetingUrl: 'http://example.com',
    scheduledAt: '2019-08-24T14:15:22Z'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.sureshake.com/v2/entities/<entityId>/engagement-invitations"

payload = {
    "relationshipId": "928dd5b8-3ead-4528-bdef-9c0b867a5d7d",
    "targetLabel": "string",
    "message": "string",
    "idempotencyKey": "0c14c6a6-6f50-4d1e-b0c4-b46ff43ba6a1",
    "kind": "meeting",
    "meetingUrl": "http://example.com",
    "scheduledAt": "2019-08-24T14:15:22Z"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "startupListingId": "d16a646b-f433-44ce-aaae-42761cf79f25",
    "relationshipId": "928dd5b8-3ead-4528-bdef-9c0b867a5d7d",
    "recipientPrincipal": {
      "type": "user",
      "id": "string"
    },
    "recipientUserIds": [
      "string"
    ],
    "kind": "meeting",
    "targetLabel": "string",
    "message": "string",
    "meetingUrl": "http://example.com",
    "scheduledAt": "2019-08-24T14:15:22Z",
    "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9",
    "capitalObjectiveId": "8ac32681-95ce-46a0-95c6-18dd3f823038",
    "status": "sent",
    "invitedByUserId": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}