ConversationsAddress Configuration

Update Configuration Address

POST
/v1/Configuration/Addresses/{Sid}

Update an existing address configuration

Authorization

accountSid_authToken
AuthorizationBasic <token>

In: header

Path Parameters

Sid*string

The SID of the Address Configuration resource. This value can be either the sid or the address of the configuration

Request Body

application/x-www-form-urlencoded

FriendlyName?string

The human-readable name of this configuration, limited to 256 characters. Optional.

AutoCreation.Enabled?boolean

Enable/Disable auto-creating conversations for messages to this address

AutoCreation.Type?ConfigurationAddressAutoCreationType

Value in

  • "webhook"
  • "studio"
  • "default"
AutoCreation.ConversationServiceSid?string

Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.

Match^IS[0-9a-fA-F]{32}$
Length34 <= length <= 34
AutoCreation.WebhookUrl?string

For type webhook, the url for the webhook request.

AutoCreation.WebhookMethod?ConfigurationAddressMethod

Value in

  • "get"
  • "post"
AutoCreation.WebhookFilters?array<string>

The list of events, firing webhook event for this Conversation. Values can be any of the following: onMessageAdded, onMessageUpdated, onMessageRemoved, onConversationUpdated, onConversationStateUpdated, onConversationRemoved, onParticipantAdded, onParticipantUpdated, onParticipantRemoved, onDeliveryUpdated

AutoCreation.StudioFlowSid?string

For type studio, the studio flow SID where the webhook should be sent to.

Match^FW[0-9a-fA-F]{32}$
Length34 <= length <= 34
AutoCreation.StudioRetryCount?integer

For type studio, number of times to retry the webhook request

Response Body

application/json

curl -X POST "https://example.com/v1/Configuration/Addresses/string" \  -H "Content-Type: application/x-www-form-urlencoded" \  -d 'FriendlyName=My+Test+Configuration+Updated&AutoCreation.Type=studio&AutoCreation.StudioFlowSid=FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AutoCreation.StudioRetryCount=3'
{  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "address": "+37256123457",  "type": "sms",  "friendly_name": "My Test Configuration Updated",  "address_country": "CA",  "auto_creation": {    "enabled": false,    "type": "studio",    "conversation_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",    "studio_flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",    "studio_retry_count": 3  },  "date_created": "2016-03-24T21:05:50Z",  "date_updated": "2016-03-24T21:05:51Z",  "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}