Skip to main content

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

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 string

    Possible values: [viewer, cc]

    Default value: viewer

    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.

    locale string

    Possible values: [sv-SE, en-US]

    Default value: sv-SE

    Optional. The locale for the observer. Can be overridden by the observer in the signing room (if observer_Scope is 'viewer'), but the locale provided by you will serve as the default in initial communication. If not specified, the default locale for the agreement will be used.

Responses​

POST /agreements/:agreement_id/observers Successful response

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'.

    locale stringnullable

    Possible values: [sv-SE, en-US]

    The locale for the observer. Can be overridden from the signing room (if the observer_scope is 'viewer'), but this value serves as the default if nothing else is specified.

    observer_scope stringrequired

    Possible values: [cc, viewer]

    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.

    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

Loading...