Create an Observer

POST 
/agreements/:agreement_id/observers

Creates a new observer. Use the observer ID in subsequent requests.

Request

Path Parameters

agreement_id cuidrequired

POST /agreements/:agreement_id/observers parameter

application/json

Body

POST /agreements/:agreement_id/observers request body

email email

The email of the observer. Will be used in all communication, if email communication is enabled for the agreement.

name string

The name of the observer

observer_scope object

Either "viewer" or "cc". If the observer is a viewer, they will gain access to the signing room. Otherwise they will only receive a copy of the signed document.

oneOf

MOD1

string

MOD2

string

Responses

200

POST /agreements/:agreement_id/observers Successful response

application/json

Schema

Schema

version stringrequired

Possible values: [1.0]

The version of the response schema

result_type stringrequired

Possible values: [single]

A single object of the observer resource.

resource_type stringrequired

Possible values: [observer]

Data contains the observer resource.

data objectrequired

The resource data.

id cuidrequired

The unique identifier of the observer

resource_type stringrequired

Possible values: [observer]

name stringnullablerequired

The name of the observer. Required if no email is provided.

email stringnullablerequired

The email of the observer. Required if agreement is configured to send emails or if the observer_scope is 'cc'.

observer_scope object required

The scope of the observer. If specified as viewer, they will gain access to the signing room to follow the process. Otherwise, they will only receive the final, signed document.

oneOf

MOD1

string

MOD2

string

agreement cuidrequired

The unique identifier for the agreement this observer belongs to

signing_room_url urlnullablerequired

The URL to the signing room for the observer. Only available after the agreement is not in draft.

created_at stringrequired

UTC datetime ISO string

updated_at stringrequired

UTC datetime ISO string

Example (from schema)

{
  "version": "1.0",
  "result_type": "single",
  "resource_type": "observer",
  "data": {
    "id": "cdzpdorii4avtx7gvmiexample",
    "resource_type": "observer",
    "name": "Jane Doe",
    "email": "jane.doe@example.com",
    "observer_scope": "cc",
    "agreement": "coenaybsp9nym2cgbfzexample",
    "signing_room_url": "https://www.zigned.se/sign/cop0ia9liqgukxrzjmpexample/cm2imfnwoclvp5sqn9sexample",
    "created_at": "2024-01-01T00:00:00.000Z",
    "updated_at": "2024-01-01T00:00:00.000Z"
  }
}

400

POST /agreements/:agreement_id/observers Error response

application/json

Schema

Schema

status stringrequired

Possible values: [error]

error objectrequired
code int64required
Possible values: >= 400 and <= 599
message stringrequired
request_id uuidrequired

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "message": "string",
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Loading...