Identra Docs
Reference / Settings

PUT /v1/applications/{id}/providers/messaging

PUT /v1/applications/{id}/providers/messaging
Secret API key operationId: upsert_messaging

Authorization

Server-to-server. Send a secret key as a Bearer token plus the x-application-id header.

Path parameters

  • id string<uuid> required

    Application id

Request body · required

  • channel string required
  • config any
  • kind string required
  • secret string

    Plaintext secret; stored encrypted. Omit to keep the existing secret.

Responses

200 Saved
{
  "data": {
    "channel": "string",
    "config": {},
    "has_secret": false,
    "kind": "string",
    "status": "string",
    "updated_at": "2026-01-15T09:30:00Z",
    "verified_at": "2026-01-15T09:30:00Z"
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "meta": {
    "timestamp": "string"
  },
  "success": false
}
422 Production may not use the shared sender

Request

curl -X PUT "http://localhost:8080/v1/applications/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f/providers/messaging" \
  -H "Content-Type: application/json" \
  -d '{
  "channel": "string",
  "config": {},
  "kind": "string",
  "secret": "string"
}'

Try it

live request
PUT http://localhost:8080/v1/applications/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f/providers/messaging

Path parameters

Request body

application/json