Menu

Expand
Rate this page:

CustomerProfile Resource

CustomerProfile properties

Resource Properties in REST API format
sid
sid<BU> Not PII

The unique string that we created to identify the Customer-Profile resource.

account_sid
sid<AC> Not PII

The SID of the Account that created the Customer-Profile resource.

policy_sid
sid<RN> Not PII

The unique string of a policy that is associated to the Customer-Profile resource.

friendly_name
string Not PII

The string that you assigned to describe the resource.

status
enum:status Not PII

The verification status of the Customer-Profile resource.

valid_until
date_time<iso8601> Not PII

The date and time in GMT in ISO 8601 format when the resource will be valid until.

email
string Not PII

The email address that will receive updates when the Customer-Profile resource changes status.

status_callback
url Not PII

The URL we call to inform your application of status changes.

date_created
date_time<iso8601> Not PII

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updated
date_time<iso8601> Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

url
url Not PII

The absolute URL of the Customer-Profile resource.

links
uri_map Not PII

The URLs of the Assigned Items of the Customer-Profile resource.

Create a CustomerProfile resource

post
https://trusthub.twilio.com/v1/CustomerProfiles
Parameters
Parameters in REST API format
friendly_name
Required
post string Not PII

The string that you assigned to describe the resource.

email
Required
post string Not PII

The email address that will receive updates when the Customer-Profile resource changes status.

policy_sid
Required
post sid<RN> Not PII

The unique string of a policy that is associated to the Customer-Profile resource.

status_callback
Optional
post url Not PII

The URL we call to inform your application of status changes.

Example 1
Loading Code Sample...
        
        

        Create Customer Profiles

        Fetch a CustomerProfile resource

        get
        https://trusthub.twilio.com/v1/CustomerProfiles/{Sid}
        Parameters
        Parameters in REST API format
        sid
        Path
        get sid<BU> Not PII

        The unique string that we created to identify the Customer-Profile resource.

        Example 1
        Loading Code Sample...
              
              

              Fetch Customer Profiles

              Read multiple CustomerProfile resources

              get
              https://trusthub.twilio.com/v1/CustomerProfiles
              Parameters
              Parameters in REST API format
              status
              Optional
              get ienum:status Not PII

              The verification status of the Customer-Profile resource.

              friendly_name
              Optional
              get string Not PII

              The string that you assigned to describe the resource.

              policy_sid
              Optional
              get sid<RN> Not PII

              The unique string of a policy that is associated to the Customer-Profile resource.

              Example 1
              Loading Code Sample...
                    
                    

                    Read Customer Profiles

                    Update a CustomerProfile resource

                    post
                    https://trusthub.twilio.com/v1/CustomerProfiles/{Sid}
                    Parameters
                    Parameters in REST API format
                    sid
                    Path
                    post sid<BU> Not PII

                    The unique string that we created to identify the Customer-Profile resource.

                    status
                    Optional
                    post ienum:status Not PII

                    The verification status of the Customer-Profile resource.

                    status_callback
                    Optional
                    post url Not PII

                    The URL we call to inform your application of status changes.

                    friendly_name
                    Optional
                    post string Not PII

                    The string that you assigned to describe the resource.

                    email
                    Optional
                    post string Not PII

                    The email address that will receive updates when the Customer-Profile resource changes status.

                    Example 1
                    Loading Code Sample...
                          
                          

                          Update Customer Profiles

                          Delete a CustomerProfile resource

                          delete
                          https://trusthub.twilio.com/v1/CustomerProfiles/{Sid}
                          Parameters
                          Parameters in REST API format
                          sid
                          Path
                          delete sid<BU> Not PII

                          The unique string that we created to identify the Customer-Profile resource.

                          Example 1
                          Loading Code Sample...
                                
                                

                                Delete Customer Profiles

                                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 by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

                                Loading Code Sample...
                                      
                                      
                                      

                                      Thank you for your feedback!

                                      Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

                                      Sending your feedback...
                                      🎉 Thank you for your feedback!
                                      Something went wrong. Please try again.

                                      Thanks for your feedback!

                                      thanks-feedback-gif