Skip to content
em sa em sa

Transfer deal ownership

POST
/api/canvas/{deal_id}/share/transfer-ownership
 
curl --request POST \
  --url https://example.com/api/canvas/example/share/transfer-ownership \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "new_owner_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Transfer ownership of a deal to another collaborator. The current owner is demoted to editor. Requires owner role.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
deal_id
required
Deal Id
string

Request Body required

Section titled “Request Body required ”
Media type application/json
TransferOwnershipRequest
object
new_owner_id
required
New Owner Id
string format: uuid
Example generated
{
  "new_owner_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
TransferOwnershipResponse

Response from POST /canvas/{deal_id}/share/transfer-ownership.

object
success
required
Success
boolean
deal_id
required
Deal Id
string
new_owner_id
required
New Owner Id
string
new_owner_role
required
New Owner Role
string
previous_owner_id
required
Previous Owner Id
string
previous_owner_role
required
Previous Owner Role
string
Example generated
{
  "success": true,
  "deal_id": "example",
  "new_owner_id": "example",
  "new_owner_role": "example",
  "previous_owner_id": "example",
  "previous_owner_role": "example"
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}