INinfobip
customer-engagement
conversations
conversation-notes

Create note

Use this method to create a new note. Use notes to notify your team on important matters regarding a conversation with a customer. <a href="https://www.infobip.com/docs/conversations-api/notes" target="_blank">More info</a>

post/ccaas/1/conversations/{conversationId}/notes

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Path parameters

conversationIdstring required

Id of the conversation to set note to.

Request body

type'INTERNAL' | 'ATTACHMENT'
contentE89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2NoteContent required

Notes content can be any text.

agentIdstring

Agent Id, creator of note.

Response

OK

idstring

Note Id

conversationIdstring

Id of the conversation holding the note.

agentIdstring

Id of the author agent.

contentstring

Note content, which can be any text up to 4000 characters.

type'INTERNAL' | 'AUTH_BIOMETRY_INIT' | 'AUTH_BIOMETRY_PENDING' | 'AUTH_BIOMETRY_SUCCESS' | 'AUTH_BIOMETRY_EXPIRED' | 'AUTH_BIOMETRY_CANCEL' | 'AUTH_BIOMETRY_FAILED' | 'AUTH_AGENT_SUCCESS' | 'AUTH_AGENT_EXPIRED' | 'AUTH_BOT_SUCCESS' | 'AUTH_BOT_EXPIRED' | 'JIRA_COMMENT' | 'ATTACHMENT' | 'INTERNAL' | 'ATTACHMENT'
createdAtstring date-time

Time stamp when note is created.

updatedAtstring date-time

Time stamp when note is updated.

Example response

{
  "agentId": "1367466e-7e5d-40d7-a78a-ace2780ed3dd",
  "content": "Sample Note content"
}

Changes

No recorded changes to this operation across all 1 revision of this API.