Skip to main content

Update business beneficial

PUT /api/v1/BusinessesBeneficials/update

Description

This endpoint allows the updating of an existing business beneficial.

Request

-Path

/api/v{version}/BusinessesBeneficials/update

Headers

  • Accept-Language: Change default response message language from English(en). Available languages fr,en

Path Parameters

  • version: API version.

Request Body

jsonCopy code{
"schema": {
"$ref": "#/components/schemas/UpdateBusinessBeneficialRequest"
}
}

Response

Success (200)
jsonCopy code{
"schema": {
"$ref": "#/components/schemas/CreateBusinessBeneficialResponseResponse"
}
}

/api/v`{{version}}`/BusinessesBeneficials/update

Headers

Content-TypeValue
Accept-Language

Headers

Content-TypeValue
Content-Typeapplication/json

Headers

Content-TypeValue
Accepttext/plain

Body (raw)

{
"id": `<uuid>`,
"isSignee": `<boolean>`,
"votingShare": `<float>`,
"relationshipToBusiness": 2
}

Response: 200

{
"succeeded": `<boolean>`,
"message": `<string>`,
"errors": [
`<string>`,
`<string>`
],
"data": {
"id": `<uuid>`,
"isSignee": `<boolean>`,
"personId": `<uuid>`,
"businessId": `<uuid>`,
"votingShare": `<float>`,
"relationshipToBusiness": 1
}
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request PUT \ 
--url /api/v1/BusinessesBeneficials/update \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!