署名設定の更新

既存の署名設定を更新し、署名名の変更に対応します。更新後、署名のステータスは「審査待ち」に戻ります。

リクエストURL

PUT https://smsapi.engagelab.com/v1/sign-configs/:signId

呼び出し認証

APIリクエストの認証方法については、呼び出し認証を参照してください。

リクエスト例

リクエストヘッダー

              
              PUT /v1/sign-configs/987654321  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

リクエストボディ

              
              {
  "sign_name": "Company Name"
}

            

リクエストパラメータ

パスパラメータ

リクエストボディパラメータ

レスポンスパラメータ

成功レスポンス

HTTPステータスコードは200で、レスポンスボディには次のフィールドが含まれます。

成功例

              
              {
  "code": 0,
  "message": "success"
}

            

エラーレスポンス

HTTPステータスコードは4xx/5xxで、レスポンスボディには次のフィールドが含まれます。

エラー例

              
              {
  "code": 400,
  "message": "can not update pending status sign"
}

            

エラーコード

よくあるエラーメッセージ：

• invalid signId：署名IDの形式エラー
• sign config not exist：署名設定が存在しません
• sign_name already exist：署名名がすでに存在します
• can not update pending status sign：審査待ちステータスの署名は更新できません
• there are pending or running plans using current sign, can not update：この署名を使用している審査待ちまたは実行中のプランがあるため、更新できません

注意事項

1. 「審査待ち」ステータスの署名は更新できません。
2. この署名を使用している審査待ちまたは実行中のメッセージプランがある場合は、更新できません。
3. 更新後、署名のステータスは「審査待ち」（status=1）に戻ります。
4. 署名名には禁止文字を含めることはできません：【、】、[、]
5. 署名IDは文字列型の数値です。

付録

署名設定のステータス（status）