Invite member

POST

https://api.sureshake.com/v2/entities/{id}/team/invite

Path parameters

id
string
required
format: uuid

Request body JSON

userId
optional
string
email
optional
string
format: email
name
optional
string
role
optional
admin
or
executive
or
board_member
or
employee
or
advisor
title
optional
string
message
optional
string
portfolioRole
optional
admin
or
editor
or null

Returns

200

Default Response

JSON

type
existing_user
or
email_invitation
required
member
optional
object
- id
  string
  required
  format: uuid
- entityId
  string
  required
  format: uuid
- userId
  string
  required
- status
  string
  required
- role
  owner
  or
  admin
  or
  executive
  or
  board_member
  or
  employee
  or
  advisor
  or null
  required
- title
  string
  or null
  required
- portfolioRole
  string
  or null
  required
- current
  boolean
  required
- visibleOnProfile
  boolean
  required
- invitedBy
  string
  required
- invitedAt
  string
  required
  format: date-time
- respondedAt
  string
  or null
  required
  format: date-time
- startDate
  string
  or null
  required
  format: date-time
- endDate
  string
  or null
  required
  format: date-time
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
- user
  optional
  object
  or null
  id
  string
  required
  name
  string
  or null
  required
  email
  string
  or null
  required
  avatar
  string
  or null
  required
  bio
  optional
  string
  or null
  company
  optional
  string
  or null
  title
  optional
  string
  or null
- entity
  optional
  object
  or null
  id
  string
  required
  format: uuid
  name
  string
  required
  slug
  optional
  string
  or null
  logoUrl
  optional
  string
  or null
  description
  optional
  string
  or null
- inviter
  optional
  object
  or null
  id
  string
  required
  name
  string
  or null
  required
  avatar
  string
  or null
  required
}
invitation
optional
unknown

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
}

503

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
}

curl --request POST \ --url 'https://api.sureshake.com/v2/entities/<id>/team/invite' \ --header 'Content-Type: application/json' \ --data ' { "userId": "string", "email": "user@example.com", "name": "string", "role": "admin", "title": "string", "message": "string", "portfolioRole": "admin" } '

{ "type": "existing_user", "member": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "userId": "string", "status": "string", "role": "owner", "title": "string", "portfolioRole": "string", "current": true, "visibleOnProfile": true, "invitedBy": "string", "invitedAt": "2019-08-24T14:15:22Z", "respondedAt": "2019-08-24T14:15:22Z", "startDate": "2019-08-24T14:15:22Z", "endDate": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "user": { "id": "string", "name": "string", "email": "string", "avatar": "string", "bio": "string", "company": "string", "title": "string" }, "entity": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "slug": "string", "logoUrl": "string", "description": "string" }, "inviter": { "id": "string", "name": "string", "avatar": "string" } }, "invitation": null }