Edit a Pool

Edits an existing pool

RESPONSE PARAMETERS

KEY

DESCRIPTION

poolId

The tracking id of the pool.

poolName

The name of the pool.

smsSettings

The SMS settings of the pool.

smsSettings.sticky

When enabled, the service should try to always use the same number, as sender, for each recipient.

smsSettings.geomatch

When enabled, the service should try to use, as sender, a number that matches the destination country.

smsSettings.transcode

When enabled, the SMS message will get transcoded (when possible).

smsSettings.defaultCountry

A country code in ISO 3166-1 alpha-2 format. Routee will use a number from this defaultCountry as sender, if there is not a more suitable option (eg a number from the same country or a sticky sender for the recipient).

smsSettings.alphanumericSenderId

The alphanumeric Sender Id that will be used, when the pool strategy is "Alphanumeric".

smsSettings.inboundSMSCallbackUrl

Defines the callback URL that will receive the inbound messages to the numbers of the pool.

smsSettings.callback

Defines the callback URL that will receive the status update notifications for your outbound SMS messages.

smsSettings.callback.url

A URL that Routee will POST to, each time your message status changes.

smsSettings.callback.strategy

Defines when the URL will be called. Two possible values: on every status change (OnChange) or when a final status arrives (OnCompletion).

updatedAt

The timestamp the pool is updated.

Language