Create field

POST /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields

TODO: Resource-level docs

Path parameters

  • AssistantSid string Required

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

  • TaskSid string Required

    The SID of the Task resource associated with the new Field resource.

Body

  • FieldType string Required

    The Field Type of the new field. Can be: a Built-in Field Type, the unique_name, or the sid of a custom Field Type.

  • UniqueName string Required

    An application-defined string that uniquely identifies the new resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the sid in the URL path to address the resource.

Responses

  • 201

    Created

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • assistant_sid string | null

      The SID of the Assistant that is the parent of the Task associated with the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^UA[0-9a-fA-F]{32}$.

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • field_type string | null

      The Field Type of the field

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^UE[0-9a-fA-F]{32}$.

    • task_sid string | null

      The SID of the Task resource associated with this Field

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^UD[0-9a-fA-F]{32}$.

    • unique_name string | null

      An application-defined string that uniquely identifies the resource

    • url string(uri) | null

      The absolute URL of the Field resource
POST /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields 
curl \
 -X POST https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'FieldType=string&UniqueName=string'
Request example 
{
  "FieldType": "string",
  "UniqueName": "string"
}
Request examples 
{
  "FieldType": "string",
  "UniqueName": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "assistant_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "field_type": "string",
  "sid": "string",
  "task_sid": "string",
  "unique_name": "string",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "assistant_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "field_type": "string",
  "sid": "string",
  "task_sid": "string",
  "unique_name": "string",
  "url": "https://example.com"
}