Create a new Evaluation

POST /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations

TODO: Resource-level docs

Create a new Evaluation

Path parameters

  • CustomerProfileSid string Required

    The unique string that we created to identify the CustomerProfile resource.

Body

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

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

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

    • date_created string(date-time) | null
    • 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}$.

    • results array | null

      The results of the Evaluation resource

    • sid string | null

      The unique string that identifies the Evaluation resource

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

    • status string | null

      The compliance status of the Evaluation resource

      Values are compliant or noncompliant.

    • url string(uri) | null
POST /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations 
curl \
 -X POST https://trusthub.twilio.com/v1/CustomerProfiles/{CustomerProfileSid}/Evaluations \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'PolicySid=string'
Request example 
{
  "PolicySid": "string"
}
Request examples 
{
  "PolicySid": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "customer_profile_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "policy_sid": "string",
  "results": [],
  "sid": "string",
  "status": "compliant",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "customer_profile_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "policy_sid": "string",
  "results": [],
  "sid": "string",
  "status": "compliant",
  "url": "https://example.com"
}