Skip to main content

Delete an Observer

DELETE 
/agreements/:agreement_id/observers/:observer_id

Deletes an existing observer

Request​

Path Parameters

    agreement_id cuidrequired

    DELETE /agreements/:agreement_id/observers/:observer_id parameter

    observer_id cuidrequired

    DELETE /agreements/:agreement_id/observers/:observer_id parameter

Responses​

DELETE /agreements/:agreement_id/observers/:observer_id Successful response

Schema
    version stringrequired

    Possible values: [1.0]

    The version of the response schema

    result_type stringrequired

    Possible values: [deleted]

    Returns a single object of the observer resource which was deleted.

    resource_type stringrequired

    Possible values: [observer]

    Data contains the observer resource.

    data objectrequired

    The resource data that was deleted.

    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

    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

Loading...