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?

Field Value

The FieldValue resource provides sample values associated with a Field Type.

For example, if the Field Type is city some sample values could be San Francisco, London, Tallinn or Bogota. You do not need to enter every possible value. Twilio's Autopilot is smart enough to detect cities even you haven't explicitly entered every option as a value. That said, the more Field Values you provide the training model, the better.

All Autopilot REST API resources use the following base URL.

https://autopilot.twilio.com/v1

FieldValue properties

Names in REST API format
account_sid
sid<AC> Not PII

The SID of the Account that created the FieldValue resource.

date_created
date_time<iso8601> Not PII

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

date_updated
date_time<iso8601> Not PII

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

field_type_sid
sid<UB> Not PII

The SID of the Field Type associated with the Field Value.

language
string Not PII

The ISO language-country tag that specifies the language of the value. Currently supported tags: en-US

assistant_sid
sid<UA> Not PII

The SID of the Assistant that is the parent of the FieldType associated with the resource.

sid
sid<UC> Not PII

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

value
string Not PII

The Field Value data.

url
url Not PII

The absolute URL of the FieldValue resource.

synonym_of
sid<UC> Not PII

The word for which the field value is a synonym of.

Create a FieldValue resource

post
https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues

Creates a new Field Value for the Field Type specified by the {FieldTypeSid}.

Parameters
Names in REST API format
assistant_sid
Path
post sid_like<UA> Not PII

The SID of the Assistant that is the parent of the FieldType associated with the new resource.

field_type_sid
Path
post sid_like<UB> Not PII

The SID of the Field Type associated with the Field Value.

language
Required
post string Not PII

The ISO language-country tag that specifies the language of the value. Currently supported tags: en-US

value
Required
post string Not PII

The Field Value data.

synonym_of
Optional
post sid_like<UC> Not PII

The string value that indicates which word the field value is a synonym of.

Example 1
        
        
        
        

        Fetch a FieldValue resource

        get
        https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}

        Returns the Field Value instance identified by {FieldValueSid} or {Value}.

        Parameters
        Names in REST API format
        assistant_sid
        Path
        get sid_like<UA> Not PII

        The SID of the Assistant that is the parent of the FieldType associated with the resource to fetch.

        field_type_sid
        Path
        get sid_like<UB> Not PII

        The SID of the Field Type associated with the Field Value to fetch.

        sid
        Path
        get sid_like<UC> Not PII

        The Twilio-provided string that uniquely identifies the FieldValue resource to fetch.

        Example 1
              
              
              
              

              Read multiple FieldValue resources

              get
              https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues

              Returns the list of Field Values for this Field Type. The list includes paging information.

              Parameters
              Names in REST API format
              assistant_sid
              Path
              get sid_like<UA> Not PII

              The SID of the Assistant that is the parent of the FieldType associated with the resources to read.

              field_type_sid
              Path
              get sid_like<UB> Not PII

              The SID of the Field Type associated with the Field Value to read.

              language
              Optional
              get string Not PII

              The ISO language-country tag that specifies the language of the value. Currently supported tags: en-US

              Example 1
                    
                    
                    
                    

                    Delete a FieldValue resource

                    delete
                    https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}

                    Deletes a Field Value.

                    Parameters
                    Names in REST API format
                    assistant_sid
                    Path
                    delete sid_like<UA> Not PII

                    The SID of the Assistant that is the parent of the FieldType associated with the resources to delete.

                    field_type_sid
                    Path
                    delete sid_like<UB> Not PII

                    The SID of the Field Type associated with the Field Value to delete.

                    sid
                    Path
                    delete sid_like<UC> Not PII

                    The Twilio-provided string that uniquely identifies the FieldValue resource to delete.

                    Example 1
                          
                          
                          
                          
                          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.