WIwithallo
Notes

Create conversation note

Changed on

Adds an internal team note to a conversation. Notes are never visible to the contact.

post/v2/api/conversations/{contact_number}/notes

Request

  • Base URL
    https://api.withallo.com
  • URL
    https://api.withallo.com/v2/api/conversations/{contact_number}/notes
  • Auth
    API key in header Authorization

Path parameters

contact_numberstring required
Example:+14155551234

The contact's phone number (E.164)

Request body

contentstring required

Note text (max 4000 characters). Mention teammates inline with @[Name](usr-...), or @[all](all) to notify the whole team.

allo_numberstring

The Allo line the conversation belongs to (E.164). Required unless sender_id is provided.

sender_idstring nullable

Sender-ID inbox identifier, as an alternative to allo_number for sender-ID conversations.

Example request

{
  "content": "Escalate to @[Jane Doe](usr-abc123) tomorrow",
  "allo_number": "+14155550100"
}

Response

Note created

Example response

{
  "data": {
    "id": "not-2NyMabc123",
    "contact_number": "+14155551234",
    "allo_number": "+14155550100",
    "user": {
      "id": "usr-def456",
      "name": "John Smith"
    },
    "mentions": [
      {
        "user_id": "usr-abc123",
        "name": "Jane Doe"
      }
    ]
  }
}

Changes