Skip to main content
POST
/
contracts
/
{id}
/
parties
Create Contract Party
curl --request POST \
  --url https://v1.api.flux-os.com/contracts/{id}/parties \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-id: <api-key>' \
  --data '
{
  "organization": "<unknown>",
  "role": "<unknown>",
  "entity": "<unknown>"
}
'
{
  "data": {
    "contract": "<unknown>",
    "id": "<string>",
    "organization": {
      "name": "<string>",
      "id": "<string>",
      "image_url": null
    },
    "entity": {
      "legal_name": "<string>",
      "id": "<string>"
    },
    "role": {
      "name": "<string>",
      "short_code": "<string>",
      "id": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "users": [
      {
        "party": "<unknown>",
        "id": "<string>",
        "user": {
          "first_name": "<string>",
          "last_name": "<string>",
          "id": "<string>",
          "roles": "<unknown>"
        },
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required
x-user-id
string
header
required

Path Parameters

id
integer
required

The contract ID.

Body

application/json
organization
any
required
role
any
required
entity
unknown

Response

Contract party successfully created.

data
object