TSGGLOBAL Support sign in
Skip to page content
Browse TNID API docs

TNID API documentation User Telephone number Update User Telephone Number

Update User Telephone Number

On this page

GraphQL endpoint: /user

Updates the types and visibility settings of an existing user telephone number. The telephone number itself cannot be changed, only its metadata like types and visibility.

Query

mutation (
  $id: ID!
  $types: [UserTelephoneNumberType!]
  $visibility: [UserVisibilityType!]
) {
  updateUserTelephoneNumber (
    id: $id
    types: $types
    visibility: $visibility
  ) {
    id
    number
    types
    visibility
    primary
    status
  }
}

Variables

{
  "id": "00000000-0000-4000-8000-000000000001",
  "types": [
    "HOME"
  ],
  "visibility": [
    "FAMILY"
  ]
}

Response

{
  "data": {
    "updateUserTelephoneNumber": {
      "id": "00000000-0000-4000-8000-000000000001",
      "number": "1",
      "primary": true,
      "status": "VERIFIED",
      "types": [
        "HOME"
      ],
      "visibility": [
        "FAMILY"
      ]
    }
  }
}