Create a new Notification for the corresponding Challenge

POST /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{ChallengeSid}/Notifications

TODO: Resource-level docs

Create a new Notification for the corresponding Challenge

Path parameters

  • ServiceSid string Required

    The unique SID identifier of the Service.

  • Identity string Required

    Customer unique identity for the Entity owner of the Challenge. 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.

  • ChallengeSid string Required

    The unique SID identifier of the Challenge.

Body

  • Ttl integer

    How long, in seconds, the notification is valid. Can be an integer between 0 and 300. Default is 300. Delivery is attempted until the TTL elapses, even if the device is offline. 0 means that the notification delivery is attempted immediately, only once, and is not stored for future delivery.

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}$.

    • challenge_sid string | null

      Challenge Sid.

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

    • date_created string(date-time) | null

      The date this Notification was created

    • entity_sid string | null

      Entity Sid.

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

    • identity string | null

      Unique external identifier of the Entity

    • priority string | null

      The priority of the notification.

    • 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 Notification.

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

    • ttl integer | null

      How long, in seconds, the notification is valid.
POST /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{ChallengeSid}/Notifications 
curl \
 -X POST https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{ChallengeSid}/Notifications \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Ttl=42'
Request example 
{
  "Ttl": 42
}
Request examples 
{
  "Ttl": 42
}
Response examples (201) 
{
  "account_sid": "string",
  "challenge_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "entity_sid": "string",
  "identity": "string",
  "priority": "string",
  "service_sid": "string",
  "sid": "string",
  "ttl": 42
}
Response examples (201) 
{
  "account_sid": "string",
  "challenge_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "entity_sid": "string",
  "identity": "string",
  "priority": "string",
  "service_sid": "string",
  "sid": "string",
  "ttl": 42
}