Create pin

Creates a new pin with a first comment on a quotation.

  • Anonymous users: Must provide authorName and optionally authorEmail

    • Authenticated users: Author info is automatically set from user profile (can add X-API-KEY header)

    Body Fields

    FieldTypeRequiredDescription
    quotationUuidstring (UUID)YesTarget quotation identifier
    contentstringYesFirst comment content
    authorNamestringNo*Name of the author (*required if anonymous)
    authorEmailstringNoEmail of the author
    offsetXfloatNoHorizontal position of the pin
    offsetYfloatNoVertical position of the pin
    zoneIdstringNoZone identifier where the pin is placed

    Response Fields

    FieldTypeDescription
    uuidstringPin unique identifier
    offsetXfloatHorizontal position
    offsetYfloatVertical position
    zoneIdstringZone identifier
    commentsarrayComments (includes first comment)
    comments[].uuidstringComment unique identifier
    comments[].contentstringComment text
    comments[].authorNamestringAuthor name
    comments[].authorobject/nullUser object if authenticated
    comments[].createdAtdatetimeComment creation timestamp
    createdAtdatetimePin creation timestamp

    Response

    • 201 Created: Pin and comment successfully created
    • 400 Bad Request: Missing required fields
    • 404 Not Found: Quotation not found
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
string
string
number
number
string
Responses
201

Resource created

400

Bad request

401

Unauthorized

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!