Skip to main content

Configure a notification provider

POST 

/api/v1/notifications/manage/configure-provider

Configures credentials and activation state for a notification provider (e.g., FCM, SendGrid, Twilio).

Uses upsert semantics: if an active integration already exists for the specified provider type, it updates the existing integration in place (preserving its ID and subscriber linkages). If no active integration exists, a new one is created.

The current read-then-upsert path does not establish atomic uniqueness under concurrent configuration. Credentials are sensitive and should stay in trusted backend tooling; the API shape is not proof that they bypass all internal journals or diagnostics.

Provider configuration outcomes​

Section ID: DOC-CP-notifications-api-configureProvider#provider-configuration-outcomes

Multiple active integrations of the same type return 409 Conflict and need support resolution. After a credential change, test delivery to an already registered device. Provider status alone does not prove arrival.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Welcome a new user with an in-app message

Request​

Responses​

Provider configured (created or updated)

Configure email delivery with your SendGrid credential; the displayed key is a placeholder.​

Section ID: DOC-CP-notifications-api-configureProvider#example-notifications-configureProvider-request

Request example

{
"provider": "PROVIDER_TYPE_SENDGRID",
"credentials": {
"apiKey": "REPLACE_WITH_SENDGRID_API_KEY"
},
"active": true
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-CP-notifications-api-configureProvider#example-notifications-configureProvider-response

Response example

{
"integrationId": "example_123",
"active": true
}

Document ID: DOC-CP-notifications-api-configureProvider. Section identities and revisions.

SectionStable reference
Configure a notification providerDOC-CP-notifications-api-configureProvider#overview
RequestDOC-CP-notifications-api-configureProvider#request
ResponsesDOC-CP-notifications-api-configureProvider#responses