Sign inGet Started
Aan de slag
Gidsen
API Reference
SDK's
CLI
Kennisbank
Changelog

Update an SMS messaging profile

PATCH
/v1/sms/messaging-profiles/{profile_id}
bird sms messaging-profiles update <profile-id> \
  --default-category transactional \
  --name device-activation
Reactie200
{
  "id": "mpr_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "device-activation",
  "senders": [
    {
      "country_code": "US",
      "sender_id": "snd_01krdgeqcxet5s7t44vh8rt9mg"
    }
  ],
  "inbound": {
    "numbers": [
      {
        "country_code": "US",
        "number": "34001"
      }
    ],
    "callback_url": "https://receipts.example.com/bird/sms/inbound",
    "outbound_matching": {
      "enabled": false,
      "time_window": "1d"
    }
  },
  "default_category": "authentication",
  "validity_period": 3600,
  "cost_center": "CC001234",
  "options": {
    "smart_encoding": false,
    "ignore_suppression": false,
    "callback_url": "https://receipts.example.com/bird/sms/activation"
  },
  "callback_events": [
    "sms.delivered",
    "sms.failed"
  ]
}

Changes a messaging profile. Properties you omit keep their value, including those inside inbound and options, and null clears a property that accepts it.

senders and inbound.numbers replace the whole list, so send every entry you want to keep. The change applies to later sends that name the profile; messages already sent keep what they used. Sends and inbound attribution can use the previous settings for up to 60 seconds.

Parameters

profile_idstring

ID of the messaging profile, as returned when you created or listed profiles.

Verzoekpayload

name
string

A new label for the profile. Names are not unique, so two profiles can share one.

senders
array of object

Replaces the profile's senders. Each country appears at most once, and at most one entry omits country_code. Send an empty array to remove them all.

Onderliggende parameters tonen
inbound
object

Changes how the profile receives replies. Omitted properties keep their value.

Onderliggende parameters tonen
default_category
nullable string

The category a free-text send that names this profile uses when it sets none: transactional, marketing, authentication, or service. A template send takes the template's category. Send null to clear it.

validity_period
nullable integer

How many seconds a message stays valid before it expires undelivered. Send null to clear it. A send that omits validity_period uses it.

cost_center
nullable string

A label for assigning the cost of this profile's messages. Send null to clear it. A send that omits cost_center uses it.

options
object

Changes the sending options for messages that do not set their own. Omitted properties keep their value.

Onderliggende parameters tonen
callback_events
nullable array

The events of this profile's outbound messages that go to a callback URL. The list is fixed when a message is accepted, and applies only while the message has a callback URL: an event outside it then reaches neither the URL nor a plain webhook endpoint. Without a callback URL the list has no effect, and every event goes to your webhook endpoints. A value other than sms.accepted, sms.sent, sms.delivered, sms.undelivered, sms.failed, sms.rejected or sms.expired returns 422. sms.received is never filtered. Send null to deliver every event.

Response Payload

id
string
verplicht

Identifier of this profile.

name
string
verplicht

A label for the profile. Names are not unique, so two profiles can share one.

senders
array of object
verplicht

The sender for each destination country, and the default sender when an entry has no country_code.

Onderliggende attributen tonen
inbound
object
verplicht

How the profile receives replies. A profile without numbers only sends.

Onderliggende attributen tonen
default_category
nullable string
verplicht

The category a free-text send that names this profile uses when it sets none: transactional, marketing, authentication, or service. A template send takes the template's category. Null when none is set.

validity_period
nullable integer
verplicht

How many seconds a message stays valid before it expires undelivered. Null when none is set. A send that omits validity_period uses it.

cost_center
nullable string
verplicht

A label for assigning the cost of this profile's messages. Null when none is set. A send that omits cost_center uses it.

options
object
verplicht

Sending options that messages from this profile use when a message does not set its own.

Onderliggende attributen tonen
callback_events
nullable array
verplicht

The events of this profile's outbound messages that go to a callback URL: sms.accepted, sms.sent, sms.delivered, sms.undelivered, sms.failed, sms.rejected, and sms.expired. The list is fixed when a message is accepted, and applies only while the message has a callback URL: an event outside it then reaches neither the URL nor a plain webhook endpoint. Without a callback URL the list has no effect, and every event goes to your webhook endpoints. sms.received is never filtered. Null means every outbound event goes to the URL.

created_at
string
verplicht

When the profile was created.

updated_at
string
verplicht

When the profile was last changed.

Gerelateerde bronnen

Ga verder met de documentatie, handleidingen en voorbeelden voor dit onderwerp.

Ontvang een implementatieoverzicht