Setup Document

Update an existing Setup Document record by ID.

put/api/cp/setup/document/{id}

Request

  • Base URL
    https://app.connexcs.com
  • Auth
    • OAuth 2
      Authorization code: https://auth.connexcs.com/authorize
      Token URL: https://auth.connexcs.com/token
    • or HTTP bearer

Path parameters

idinteger required

Id identifier

Request body

idinteger

Id

account_idinteger

Account Id

dtstring date-time

Dt

namestring required

Name

notesstring

Notes

account_notesstring

Account Notes

filenamestring

Filename

Example request

{
  "id": 12345,
  "account_id": 1,
  "dt": "2025-01-17T10:30:00Z",
  "name": "Example Name",
  "notes": "Sample notes text content",
  "account_notes": 10,
  "filename": "example_filename"
}

Response

Operation completed successfully

statusstring

Operation status

Example response

{
  "status": "OK"
}

Changes

    • info

      the endpoint scheme security oAuth2 was added to the API

    • info

      the endpoint scheme security opaqueToken was added to the API

    • info

      the endpoint scheme security basicAuth was removed from the API