Update an identity's access to a specific Sync Document

POST /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}

Sync document permissions

Update an identity's access to a specific Sync Document.

Path parameters

  • ServiceSid string Required

    The SID of the Sync Service with the Document Permission resource to update.

  • DocumentSid string Required

    The SID of the Sync Document with the Document Permission resource to update. Can be the Document resource's sid or its unique_name.

  • Identity string Required

    The application-defined string that uniquely identifies the User's Document Permission resource to update.

Body

  • Manage boolean Required

    Whether the identity can delete the Sync Document. Default value is false.

  • Read boolean Required

    Whether the identity can read the Sync Document. Default value is false.

  • Write boolean Required

    Whether the identity can update the Sync Document. Default value is false.

Responses

  • 200

    OK

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

    • document_sid string | null

      The Sync Document SID

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

    • identity string | null

      The identity of the user to whom the Sync Document Permission applies

    • manage boolean | null

      Manage access

    • read boolean | null

      Read access

    • service_sid string | null

      The SID of the Sync Service that the resource is associated with

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

    • url string(uri) | null

      The absolute URL of the Sync Document Permission resource

    • write boolean | null

      Write access
POST /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity} 
curl \
 -X POST https://sync.twilio.com/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity} \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Manage=true&Read=true&Write=true'
Request example 
{
  "Manage": true,
  "Read": true,
  "Write": true
}
Request examples 
{
  "Manage": true,
  "Read": true,
  "Write": true
}
Response examples (200) 
{
  "account_sid": "string",
  "document_sid": "string",
  "identity": "string",
  "manage": true,
  "read": true,
  "service_sid": "string",
  "url": "https://example.com",
  "write": true
}
Response examples (200) 
{
  "account_sid": "string",
  "document_sid": "string",
  "identity": "string",
  "manage": true,
  "read": true,
  "service_sid": "string",
  "url": "https://example.com",
  "write": true
}