Sign in

v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-05158112.9 KB
NotifyV1Binding

post/v1/Services/{ServiceSid}/Bindings

Path parameters

ServiceSidstring required

The SID of the Service to create the resource under.

Response

Created

sidstring nullable

The unique string that we created to identify the Binding resource.

account_sidstring nullable

The SID of the Account that created the Binding resource.

service_sidstring nullable

The SID of the Service the resource is associated with.

credential_sidstring nullable

The SID of the Credential resource to be used to send notifications to this Binding. If present, this overrides the Credential specified in the Service resource. Applicable only to apn, fcm, and gcm type Bindings.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in RFC 2822 format.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in RFC 2822 format.

notification_protocol_versionstring nullable

The protocol version to use to send the notification. This defaults to the value of default_xxxx_notification_protocol_version in the Service for the protocol. The current version is "3" for apn, fcm, and gcm type Bindings. The parameter is not applicable to sms and facebook-messenger type Bindings as the data format is fixed.

endpointstring nullable

Deprecated.

identitystring nullable

The identity value that uniquely identifies the resource's User within the Service. Up to 20 Bindings can be created for the same Identity in a given Service.

binding_typestring nullable

The transport technology to use for the Binding. Can be: apn, fcm, gcm, sms, or facebook-messenger.

addressstring nullable

The channel-specific address. For APNS, the device token. For FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format.

tagsstring[] nullable

The list of tags associated with this Binding. Tags can be used to select the Bindings to use when sending a notification. Maximum 20 tags are allowed.

urlstring uri nullable

The absolute URL of the Binding resource.

linksobject nullable

The URLs of related resources.