Company API:Notes

Add a company note

Changed on
post/companies/{companyId}/notes

Request

  • Base URL
    https://api.jobadder.com/v2
  • URL
    https://api.jobadder.com/v2/companies/{companyId}/notes
  • Auth
    OAuth 2
    Authorization code: https://id.jobadder.com/connect/authorize
    Token URL: https://id.jobadder.com/connect/token scopes: write, write_note, write_company_note

Path parameters

companyIdinteger required

Request body

typestring nullable

Note type

textstring required

Note content

contactIdinteger[] nullable

Optional list of related contacts to link to the note

referencestring nullable

Optional reference string used to identify a note or group of notes

Response

Created

noteIdstring uuid required
typestring nullable
sourcestring nullable
textstring nullable
subjectstring nullable
referencestring nullable
readonlyboolean

This note cannot be updated

createdAtstring date-time
updatedAtstring date-time nullable

Changes

    • info

      added optional request body

    • info

      added the media type application/json for the response with the status