POST /v1/Configuration/Addresses/{Sid}

Update an existing address configuration

Servers

Path parameters

Name Type Required Description
Sid String Yes

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

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
AutoCreation.Type String No

Possible values:

  • "studio"
  • "webhook"
  • "default"
AutoCreation.StudioFlowSid String No

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

AutoCreation.WebhookFilters[] Array No

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.WebhookMethod String No

Possible values:

  • "POST"
  • "GET"
AutoCreation.ConversationServiceSid String No

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

FriendlyName String No

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

AutoCreation.Enabled Boolean No

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

AutoCreation.StudioRetryCount Integer No

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

AutoCreation.WebhookUrl String No

For type webhook, the url for the webhook request.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.