Skip to main content

Create business beneficial

POST /api/v1/BusinessesBeneficials/create

Description​

This endpoint allows the creation of a new business beneficial.

Request​

  • Path

/api/v{version}/BusinessesBeneficials/create

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/CreateBusinessBeneficialRequest"
  }
}

Response​

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

/api/v1/BusinessesBeneficials/create

Headers​

Content-TypeValue
Accept-Language

Headers​

Content-TypeValue
Content-Typeapplication/json

Headers​

Content-TypeValue
Accepttext/plain

Body (raw)​

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

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 POST \ 
 --url  /api/v1/BusinessesBeneficials/create \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

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