Create a participant

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

Use this endpoint to add a new participant to an existing contract party.

Path Params

contract_id

integer

required

The unique ID of the contract.

party_id

integer

required

The ID of a party in a contract.

Body Params

Request body parameters for creating a participant.

_options

object

Defines options for the participant on the contract. See Options.

_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

required

One of the contract delivery channels.

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

required

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

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

One of the two step authentication methods.

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

Response body

object

_links

object

Links to related endpoints.

comments

object

contracts

object

contract

object

create

object

data_field

object

data_fields

object

events

object

event

object

files

object

file

object

parties

object

party

object

publish

object

self

object

template_types

object

template_type

object

template

object

templates

object

workspaces

object

workspace

object

_permissions

object

required

This attribute contains the permissions for the participant/creator on the contract.

contract:update

boolean

required

_private_ownerside

object | null

required

Participant data that is private to the ownerside.

created_time

string

required

custom_id

string | null

required

first_visited_time

string | null

required

last_visited_time

string | null

required

updated_time

string | null

required

visits

integer

required

delivery_channel

string

required

One of the contract delivery channels.

email sms email_and_sms same_device none unknown

delivery_status

string

required

One of the contract delivery status.

not_sent pending failure bounce success opened unknown

draft_approver

boolean

A flag to indicate if the participant is a draft approver.

string

required

integer

required

identification_number

string

required

length between 0 and 25

my_participant

boolean

required

name

string | null

required

organizer

boolean

required

A flag to indicate if the participant is an organizer combined with the permissions.

phone_number

string | null

required

sign_method

string

required

One of the sign methods.

standard_esign sms swedish_bankid norwegian_bankid danish_mitid finnish_bankid handwritten_signature eid_sign unknown

sign_state

string

required

One of the sign states.

undecided signed declined unknown

sign_state_updated_time

string | null

required

signatory

boolean

required

A flag to indicate if the participant is an signatory combined with the permissions.

title

string

required

length between 0 and 100

two_step_authentication_method

string

required

One of the two step authentication methods.

email sms personal_identification none unknown

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.

Language

URL


xxxxxxxxxx
14
1
curl --request POST \
2
     --url https://api.oneflow.com/v1/contracts/contract_id/parties/party_id/participants \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "_permissions": {
8
    "contract:update": false
9
  },
10
  "delivery_channel": "email",
11
  "organizer": false,
12
  "signatory": false
13
}
14
'

Choose an example:

application/json

200Returns the created participant