Deals

Add a team member to a deal

POST/deals/{deal_id}/team-members

Adds a team member to the deal and returns it with a Location. job_title is required. Without position the member goes last; with one, the members at or after it move down one, and a position past the end puts the member last. image_id must be a file in the deal's assets folder, else 422 exists. The first member turns the team tab on. A published deal accepts it. dry_run shows the result without saving it. Emits deal_team_member.created and sends no email. DELETE /deals/{deal_id}/team-members/{id} undoes it.

Path parameters

  • deal_idstring (uuid)Required#

    The deal's id, a uuid. An unknown deal, or one the token can't see, returns 404.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · DealTeamMemberCreate

  • namestringRequired#

    The team member's name.

  • job_titlestringRequired#

    The team member's job title.

  • biostring | null#

    A short biography, up to 500 characters.

  • image_idstring | null#

    The photo: a file in the deal's assets folder. Another file returns 422 exists.

  • linkedin_usernamestring | null#

    The LinkedIn username.

  • twitter_usernamestring | null#

    The X (Twitter) username.

  • positioninteger#

    Where the member appears on the team tab, from 1. Members at or after it move down one. A position past the end puts the member last. Omit it to add the member last.

{
  "name": "Ada Lovelace",
  "job_title": "Managing Partner",
  "bio": "Twenty years in venture.",
  "position": 1
}

Responses

201

The team member was added.

DealTeamMember
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "name": "string",
    "job_title": "string",
    "bio": "string",
    "image_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "linkedin_username": "string",
    "twitter_username": "string",
    "position": 1,
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/deals/{deal_id}/team-members\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "name": "Ada Lovelace",
  "job_title": "Managing Partner",
  "bio": "Twenty years in venture.",
  "position": 1
}'