Create a new Customer-Profile

POST /v1/CustomerProfiles

TODO: Resource-level docs

Create a new Customer-Profile.

Body

  • Email string Required

    The email address that will receive updates when the Customer-Profile resource changes status.

  • FriendlyName string Required

    The string that you assigned to describe the resource.

  • PolicySid string Required

    The unique string of a policy that is associated to the Customer-Profile resource.

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

  • StatusCallback string(uri)

    The URL we call to inform your application of status changes.

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

    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was last updated

    • email string | null

      The email address

    • friendly_name string | null

      The string that you assigned to describe the resource

    • links object(uri-map) | null

      The URLs of the Assigned Items of the Customer-Profile resource

    • policy_sid string | null

      The unique string of a policy.

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

    • sid string | null

      The unique string that identifies the resource.

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

    • status string | null

      The verification status of the Customer-Profile resource

      Values are draft, pending-review, in-review, twilio-rejected, or twilio-approved.

    • status_callback string(uri) | null

      The URL we call to inform your application of status changes.

    • url string(uri) | null

      The absolute URL of the Customer-Profile resource

    • valid_until string(date-time) | null

      The ISO 8601 date and time in GMT when the resource will be valid until.
POST /v1/CustomerProfiles 
curl \
 -X POST https://trusthub.twilio.com/v1/CustomerProfiles \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Email=string&FriendlyName=string&PolicySid=string&StatusCallback=https%3A%2F%2Fexample.com'
Request example 
{
  "Email": "string",
  "FriendlyName": "string",
  "PolicySid": "string",
  "StatusCallback": "https://example.com"
}
Request examples 
{
  "Email": "string",
  "FriendlyName": "string",
  "PolicySid": "string",
  "StatusCallback": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "email": "string",
  "friendly_name": "string",
  "links": {},
  "policy_sid": "string",
  "sid": "string",
  "status": "draft",
  "status_callback": "https://example.com",
  "url": "https://example.com",
  "valid_until": "2023-05-04T09:42:00+00:00"
}
Response examples (201) 
{
  "account_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "email": "string",
  "friendly_name": "string",
  "links": {},
  "policy_sid": "string",
  "sid": "string",
  "status": "draft",
  "status_callback": "https://example.com",
  "url": "https://example.com",
  "valid_until": "2024-05-04T09:42:00+00:00"
}