Skip to content
Console
On this page

Senders

A Sender is a verified origin for SMS or push: a registered number or sender id, or a push app whose APNs/FCM credentials are a Connection…

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

A Sender is a verified origin for SMS or push: a registered number or sender id, or a push app whose APNs/FCM credentials are a Connection reached through the credential service. It is used only once verified.

Service Sylphx Notify · Resource type notify.sylphx.com/Sender · Name pattern orgs/{org}/projects/{project}/envs/{env}/senders/{sender} · Shape spec_status

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/senders/{sender}.
uidstringsnd_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specSenderSpecDesired state. Required.
statusSenderStatusObserved state. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets a sender.
GETlistLists senders.
POSTcreateCreates a sender.
PATCHupdateUpdates a sender.
DELETEdeleteDeletes a sender.
POSTverifyRe-checks the sender's registration or credentials now.

get

Gets a sender.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/senders/sender · scope notify:read · effect read · Request, response and examples

list

Lists senders.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/senders · scope notify:read · effect read · paginated · Request, response and examples

create

Creates a sender.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/senders · scope notify:write · effect write · Request, response and examples

update

Updates a sender.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/senders/sender · scope notify:write · effect write · Request, response and examples

delete

Deletes a sender.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/senders/sender · scope notify:write · effect destructive · Request, response and examples

verify

Re-checks the sender's registration or credentials now.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/senders/sender:verify · scope notify:write · effect write · Request, response and examples