Update a participant by ID

put

https://{hostname}/v1/contracts/{contract_id}/parties/{party_id}/participants/{participant_id}

Use this endpoint to update a participant in a contract.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

contract_id

integer

required

The unique ID of the contract.

party_id

integer

required

The ID of a party in a contract.

participant_id

integer

required

The ID of a participant in a contract.

Body Params

Request body parameters for updating a participant.

_permissions

object

Defines permissions for the participant on the contract.

_private_ownerside

object

Contract participant attributes that are private to the ownerside.

delivery_channel

string

enum

One of the contract delivery channels.

Allowed:

string

The participant's email. An email is required in case of an owner-side participant or if the delivery channel is email.

identification_number

string

length between 0 and 25

The social security number of the participant.

name

string

length between 1 and 100

The participant's name.

organizer

boolean

Defaults to false

If true, the participant is the organizer of the contract(organizer should be an owner-side participant).

phone_number

string | null

The participant's phone number. If the delivery channel is phone number, then the participant's phone number is required.

sign_method

string

enum

One of the sign methods.

signatory

boolean

Defaults to false

If true, the participant can sign the contract.

title

string

length between 0 and 100

The title of the participant.

two_step_authentication_method

string

enum

One of the two step authentication methods.

Allowed:

Headers

x-oneflow-api-token

string

required

length between 40 and 40

The API key of your Oneflow account.

x-oneflow-user-email

string

required

The email address of a registered Oneflow user.

Responses

400

Invalid format or content of the request.

401

The API token or the user email is invalid.

404

A required entity is missing.

409

A conflict occurred with the current state of the target resource.

200Returns the updated participant