Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Service

Services are containers for your environments. You may only need one Service with many environments. When you begin working on a new application, you will likely want to create a new Service.

The unique name of your service forms the first part of your Serverless domain and cannot be updated.

Service properties

Names in PHP format
sid
sid<ZS> Not PII

The unique SID identifier of this Service.

accountSid
sid<AC> Not PII

The unique SID identifier of the Account that owns this Service.

friendlyName

A human-readable description of this Service, fewer than 256 characters.

uniqueName

A unique, URL-friendly name of this Service which forms part of the domain name, fewer than 256 characters.

includeCredentials
boolean Not PII

A boolean value that indicates whether to inject Account credentials into a Function invocation context.

dateCreated
date_time<iso8601> Not PII

The date that this Service was created, given in ISO 8601 format.

dateUpdated
date_time<iso8601> Not PII

The date that this Service was updated, given in ISO 8601 format.

url
url Not PII

The URL of this Service.

links
uri_map Not PII

Contains a dictionary of URL links to nested resources of this Service.

Create a Service resource

post
https://serverless.twilio.com/v1/Services
Parameters
Names in None format
include_credentials
Optional
post boolean Not PII

A boolean value that indicates whether to inject Account credentials into a Function invocation context. Optional, default false.

unique_name
Required
post string PII MTL: 7 DAYS

A unique, addressable name of this Service which forms part of the domain name, fewer than 256 characters. Required.

friendly_name
Required
post string PII MTL: 7 DAYS

A human-readable description of this Service, fewer than 256 characters. Required

Example 1
        
        
        
        

        Fetch a Service resource

        get
        https://serverless.twilio.com/v1/Services/{Sid}
        Parameters
        Names in None format
        sid
        Required
        get sid_like<ZS> Not PII

        Identifier of the Serverless Service Instance. Either a SID or UniqueName.

        Example
              
              
              
              

              Read multiple Service resources

              get
              https://serverless.twilio.com/v1/Services
              Example
                    
                    
                    
                    

                    Update a Service resource

                    post
                    https://serverless.twilio.com/v1/Services/{Sid}
                    Parameters
                    Names in None format
                    sid
                    Required
                    post sid<ZS> Not PII

                    The unique SID identifier of this Service.

                    include_credentials
                    Optional
                    post boolean Not PII

                    A boolean value that indicates whether to inject Account credentials into a Function invocation context. Optional.

                    friendly_name
                    Optional
                    post string PII MTL: 7 DAYS

                    A human-readable description of this Service, fewer than 256 characters. Optional

                    Example
                          
                          
                          
                          

                          Delete a Service resource

                          delete
                          https://serverless.twilio.com/v1/Services/{Sid}
                          Parameters
                          Names in None format
                          sid
                          Required
                          delete sid_like<ZS> Not PII

                          Identifier of the Serverless Service Instance. Either a SID or UniqueName.

                          Example
                                
                                
                                
                                
                                Rate this page:

                                Need some help?

                                We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.