Create or update SMS provider settings for an environment

PUT

/v1/environments/{envId}/sms-settings

curl --request PUT \
  --url https://your-notavia-host/v1/environments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/sms-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "kind": "managed", "from_number": "example", "from_sender_id": "example", "twilio_account_sid": "example", "twilio_auth_token": "example", "vonage_api_key": "example", "vonage_api_secret": "example" }'

• Self-hosted deployment

Authorizations

• apiKey

Parameters

Path Parameters

envId

required

string format: uuid

Request Body ^required

Media type application/json

object

kind

required

string

Allowed values: managed twilio vonage

from_number

string

nullable

from_sender_id

string

nullable

twilio_account_sid

string

nullable

twilio_auth_token

string

nullable

vonage_api_key

string

nullable

vonage_api_secret

string

nullable

Responses

200

Updated SMS settings.

Media type application/json

object

id

string format: uuid

kind

string

Allowed values: Managed Twilio Vonage

from_number

string

nullable

from_sender_id

string

nullable

credentials_validated

boolean

credentials_validated_at

string format: date-time

nullable

Example

{
  "kind": "Managed"
}

400

Validation or request error.

Media type application/json

object

error

required

object

type

required

string

code

required

string

message

required

string

param

string

nullable

Example ^generated

{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

401

Missing or invalid credentials.

Media type application/json

object

error

required

object

type

required

string

code

required

string

message

required

string

param

string

nullable

Example ^generated

{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

403

Credentials do not have the required scope.

Media type application/json

object

error

required

object

type

required

string

code

required

string

message

required

string

param

string

nullable

Example ^generated

{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}