Notify User Resource (Deprecated)

(error)

Danger

Twilio deprecated Notify in October 2022 and no longer supports it. Learn more about transitioning off Notify.

If you're starting a new project, use Programmable Messaging for SMS notifications. For push notifications, integrate directly with platform-specific services such as APNs for iOS or FCM for Android. If you've already built on Notify, visit the transition guide to learn about your options.

(error)

Danger

The User resource is deprecated and has been replaced by the identity property of the Binding resource.

The User resource represents a user in your application.

Because the User resource is deprecated, use the identity property of the Binding resource to identify a specific user.

(error)

Do not use Personally Identifiable Information for Identity

The systems that process this parameter assume it does not contain PII.

You should use a GUID or other pseudonymized identifier for identity instead of PII such as a person's name, home address, email or phone number. If you identify your users with PII, we recommend creating a pseudonymized identifier from their PII, for example by hashing or encrypting it, before you use it for identity.

You can read more about how we process your data in our privacy policy.

User properties

The User resource is deprecated.

Create a User resource

1curl -X POST "https://notify.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users" \
2--data-urlencode "Identity=identity" \
3-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

Output

1{
2  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3  "date_created": "2017-02-17T07:17:02Z",
4  "date_updated": "2017-02-17T07:17:02Z",
5  "identity": "identity",
6  "links": {
7    "bindings": "https://notify.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/identity/Bindings",
8    "segment_memberships": "https://notify.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/identity/SegmentMemberships"
9  },
10  "segments": [
11    "segment1"
12  ],
13  "service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
14  "sid": "NUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
15  "url": "https://notify.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/identity"
16}

Fetch a User resource

1curl -X GET "https://notify.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/NUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
2-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

Output

1{
2  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3  "sid": "NUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
4  "date_created": "2017-02-17T07:17:02Z",
5  "date_updated": "2017-02-17T07:17:02Z",
6  "identity": "identity",
7  "links": {
8    "bindings": "https://notify.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/identity/Bindings",
9    "segment_memberships": "https://notify.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/identity/SegmentMemberships"
10  },
11  "segments": [
12    "segment1"
13  ],
14  "service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
15  "url": "https://notify.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/identity"
16}

Read multiple User resources

1curl -X GET "https://notify.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users?PageSize=20" \
2-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

Output

1{
2  "users": [
3    {
4      "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
5      "date_created": "2017-02-17T07:17:02Z",
6      "date_updated": "2017-02-17T07:17:02Z",
7      "identity": "identity",
8      "links": {
9        "bindings": "https://notify.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/identity/Bindings",
10        "segment_memberships": "https://notify.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/identity/SegmentMemberships"
11      },
12      "segments": [
13        "segment1"
14      ],
15      "service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
16      "sid": "NUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
17      "url": "https://notify.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/identity"
18    }
19  ],
20  "meta": {
21    "first_page_url": "https://notify.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users?Segment=segment1&Identity=identity&PageSize=50&Page=0",
22    "key": "users",
23    "next_page_url": "https://notify.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users?Segment=segment1&Identity=identity&PageSize=50&Page=1",
24    "page": 0,
25    "page_size": 50,
26    "previous_page_url": "https://notify.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users?Segment=segment1&Identity=identity&PageSize=50&Page=0",
27    "url": "https://notify.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users?Segment=segment1&Identity=identity&PageSize=50&Page=0"
28  }
29}

Delete a User resource

1curl -X DELETE "https://notify.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/NUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
2-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN