Create a new Entity for the Service

POST /v2/Services/{ServiceSid}/Entities

TODO: Resource-level docs

Create a new Entity for the Service

Path parameters

  • ServiceSid string Required

    The unique SID identifier of the Service.

Body

  • Identity string Required

    The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.

Responses

  • 201

    Created

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

      Account Sid.

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

    • date_created string(date-time) | null

      The date this Entity was created

    • date_updated string(date-time) | null

      The date this Entity was updated

    • identity string | null

      Unique external identifier of the Entity

    • links object(uri-map) | null

      Nested resource URLs.

    • service_sid string | null

      Service Sid.

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

    • sid string | null

      A string that uniquely identifies this Entity.

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

    • url string(uri) | null

      The URL of this resource.
POST /v2/Services/{ServiceSid}/Entities 
curl \
 -X POST https://verify.twilio.com/v2/Services/{ServiceSid}/Entities \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Identity=string'
Request example 
{
  "Identity": "string"
}
Request examples 
{
  "Identity": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "identity": "string",
  "links": {},
  "service_sid": "string",
  "sid": "string",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "identity": "string",
  "links": {},
  "service_sid": "string",
  "sid": "string",
  "url": "https://example.com"
}