Change Updates

Do not miss any Conversations API changes, ever again

Subscribe to the Conversations API changelog to be up to date on recent changes.

RSS

Jul 29, 2025

main
1.0.0
Compare
1.0.0

API structure has changed

Next change
59 structure changes including:
2 Additions
57 Modifications
Modified 57 Breaking
GET /v1/Configuration/Addresses
  • Response
  • 200 response Modified
    • application/json content type Modified
      • address_configurations property Modified
        • address_country property Added
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ChatServiceSid}/ParticipantConversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • conversations property Modified
        • conversation_state property Modified
          • Type went from string | null to string
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ChatServiceSid}/Roles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • roles property Modified
        • type property Modified
          • Type went from string | null to string
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ChatServiceSid}/Roles/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Modified
        • Type went from string | null to string
          Breaking
GET /v1/Services/{ChatServiceSid}/Users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • conversations property Modified
        • conversation_state, notification_level properties Modified
          • Type went from string | null to string
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations/{ConversationSid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • conversation_state, notification_level properties Modified
        • Type went from string | null to string
          Breaking
GET /v1/Users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Users/{UserSid}/Conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • conversations property Modified
        • conversation_state, notification_level properties Modified
          • Type went from string | null to string
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Users/{UserSid}/Conversations/{ConversationSid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • conversation_state, notification_level properties Modified
        • Type went from string | null to string
          Breaking
POST /v1/Configuration/Addresses
  • Body
  • application/x-www-form-urlencoded content type Modified
    • AddressCountry property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • address_country property Added
POST /v1/Configuration/Addresses/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • address_country property Added
POST /v1/Configuration/Webhooks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • method, target properties Modified
        • Type went from string | null to string
          Breaking
POST /v1/Conversations
  • Body
  • application/x-www-form-urlencoded content type Modified
    • Bindings.Email.Address, Bindings.Email.Name properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • state property Modified
        • Type went from string | null to string
          Breaking
POST /v1/Conversations/{ConversationSid}/Messages
  • Body
  • application/x-www-form-urlencoded content type Modified
    • ContentSid, ContentVariables, Subject properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • index property Modified
        • Type went from integer | null to integer
          Breaking
      • content_sid property Added
POST /v1/Conversations/{ConversationSid}/Messages/{Sid}
  • Body
  • application/x-www-form-urlencoded content type Modified
    • Subject property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index property Modified
        • Type went from integer | null to integer
          Breaking
      • content_sid property Added
POST /v1/Conversations/{Sid}
  • Body
  • application/x-www-form-urlencoded content type Modified
    • Bindings.Email.Address, Bindings.Email.Name properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • state property Modified
        • Type went from string | null to string
          Breaking
POST /v1/Credentials
  • Response
  • 201 response Modified
    • application/json content type Modified
      • type property Modified
        • Type went from string | null to string
          Breaking
POST /v1/Credentials/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Modified
        • Type went from string | null to string
          Breaking
POST /v1/Roles
  • Response
  • 201 response Modified
    • application/json content type Modified
      • type property Modified
        • Type went from string | null to string
          Breaking
POST /v1/Roles/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Modified
        • Type went from string | null to string
          Breaking
POST /v1/Services/{ChatServiceSid}/Configuration/Webhooks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • method property Modified
        • Type went from string | null to string
          Breaking
POST /v1/Services/{ChatServiceSid}/Conversations
  • Body
  • application/x-www-form-urlencoded content type Modified
    • Bindings.Email.Address, Bindings.Email.Name properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • state property Modified
        • Type went from string | null to string
          Breaking
POST /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages
  • Body
  • application/x-www-form-urlencoded content type Modified
    • ContentSid, ContentVariables, Subject properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • index property Modified
        • Type went from integer | null to integer
          Breaking
      • content_sid property Added
POST /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}
  • Body
  • application/x-www-form-urlencoded content type Modified
    • Subject property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index property Modified
        • Type went from integer | null to integer
          Breaking
      • content_sid property Added
POST /v1/Services/{ChatServiceSid}/Conversations/{Sid}
  • Body
  • application/x-www-form-urlencoded content type Modified
    • Bindings.Email.Address, Bindings.Email.Name properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • state property Modified
        • Type went from string | null to string
          Breaking
POST /v1/Services/{ChatServiceSid}/Roles
  • Response
  • 201 response Modified
    • application/json content type Modified
      • type property Modified
        • Type went from string | null to string
          Breaking
POST /v1/Services/{ChatServiceSid}/Roles/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Modified
        • Type went from string | null to string
          Breaking
POST /v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations/{ConversationSid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • conversation_state, notification_level properties Modified
        • Type went from string | null to string
          Breaking
POST /v1/Users/{UserSid}/Conversations/{ConversationSid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • conversation_state, notification_level properties Modified
        • Type went from string | null to string
          Breaking
GET /v1/Configuration/Addresses/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • address_country property Added
GET /v1/Configuration/Webhooks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • method, target properties Modified
        • Type went from string | null to string
          Breaking
GET /v1/Conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • conversations property Modified
        • state property Modified
          • Type went from string | null to string
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • StartDate, EndDate, State, Page, PageToken query parameters Added
GET /v1/Conversations/{ConversationSid}/Messages
  • Response
  • 200 response Modified
    • application/json content type Modified
      • messages property Modified
        • index property Modified
          • Type went from integer | null to integer
            Breaking
        • content_sid property Added
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • delivery_receipts property Modified
        • status property Modified
          • Type went from string | null to string
            Breaking
        • error_code property Modified
          • Type went from integer | null to integer
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • status property Modified
        • Type went from string | null to string
          Breaking
      • error_code property Modified
        • Type went from integer | null to integer
          Breaking
GET /v1/Conversations/{ConversationSid}/Messages/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index property Modified
        • Type went from integer | null to integer
          Breaking
      • content_sid property Added
GET /v1/Conversations/{ConversationSid}/Participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Conversations/{ConversationSid}/Webhooks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Conversations/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • state property Modified
        • Type went from string | null to string
          Breaking
GET /v1/Credentials
  • Response
  • 200 response Modified
    • application/json content type Modified
      • credentials property Modified
        • type property Modified
          • Type went from string | null to string
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Credentials/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Modified
        • Type went from string | null to string
          Breaking
GET /v1/ParticipantConversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • conversations property Modified
        • conversation_state property Modified
          • Type went from string | null to string
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Roles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • roles property Modified
        • type property Modified
          • Type went from string | null to string
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Roles/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Modified
        • Type went from string | null to string
          Breaking
GET /v1/Services
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ChatServiceSid}/Bindings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • bindings property Modified
        • binding_type property Modified
          • Type went from string | null to string
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ChatServiceSid}/Bindings/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • binding_type property Modified
        • Type went from string | null to string
          Breaking
GET /v1/Services/{ChatServiceSid}/Configuration/Webhooks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • method property Modified
        • Type went from string | null to string
          Breaking
GET /v1/Services/{ChatServiceSid}/Conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • conversations property Modified
        • state property Modified
          • Type went from string | null to string
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • StartDate, EndDate, State, Page, PageToken query parameters Added
GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages
  • Response
  • 200 response Modified
    • application/json content type Modified
      • messages property Modified
        • index property Modified
          • Type went from integer | null to integer
            Breaking
        • content_sid property Added
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • delivery_receipts property Modified
        • status property Modified
          • Type went from string | null to string
            Breaking
        • error_code property Modified
          • Type went from integer | null to integer
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • status property Modified
        • Type went from string | null to string
          Breaking
      • error_code property Modified
        • Type went from integer | null to integer
          Breaking
GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index property Modified
        • Type went from integer | null to integer
          Breaking
      • content_sid property Added
GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ChatServiceSid}/Conversations/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • state property Modified
        • Type went from string | null to string
          Breaking
Added 2
POST /v1/Services/{ChatServiceSid}/ConversationWithParticipants
POST /v1/ConversationWithParticipants