Contract - Parties and Participants

Create a participant

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

post/contracts/{contract_id}/parties/{party_id}/participants

Request

Base URL
https://api.oneflow.com/v1
Auth
none declared. Required headers: x-oneflow-api-token, x-oneflow-user-email

Path parameters

contract_idinteger required

The unique ID of the contract.

party_idinteger required

The ID of a party in a contract.

Headers

x-oneflow-api-tokenstring required

The API key of your Oneflow account.

x-oneflow-user-emailstring email required

Example:john.doe@oneflow.com

The email address of a registered Oneflow user.

Request body

One of the contract delivery channels.

emailstring email

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

identification_numberstring

The social security number of the participant.

namestring required

The participant's name.

organizerboolean

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

phone_numberstring nullable

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

One of the sign methods.

signatoryboolean

If true, the participant can sign the contract.

titlestring

The title of the participant.

two_step_authentication_method'email' | 'sms' | 'personal_identification' | 'none' | 'unknown'

One of the two step authentication methods.

type'colleague' | 'former_colleague'

Whether an ownerside participant is a colleague or a former colleague. Set this to former_colleague only when creating a former colleague participant.

Example request

{
  "_options": {
    "message": {
      "body": "Your colleague John Doe needs help with a draft before sending it to the counterparty.",
      "subject": "John Doe invited you to a document"
    }
  },
  "name": "Firstname Lastname"
}

Response

Returns the created participant

One of the contract delivery channels.

One of the contract delivery status.

draft_approverboolean

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

emailstring email required

idinteger required

identification_numberstring required

my_participantboolean required

namestring nullable required

organizerboolean required

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

pending_approverboolean

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

phone_numberstring nullable required

One of the sign methods.

sign_state'undecided' | 'signed' | 'declined' | 'unknown' required

One of the sign states.

sign_state_updated_timestring datetime nullable required

signatoryboolean required

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

titlestring required

two_step_authentication_method'email' | 'sms' | 'personal_identification' | 'none' | 'unknown' required