PUT Phone

Updates the indicated phone to reflect the request data provided.

Request URL

https://{school}.myschoolapp.com/api/user/phone/[phoneId]?t={token}[&userID]

Parameters

Parameter	Required	Type	Description
phoneID		int	The ID of the phone to associate with another user. The `phoneID` is returned in the GET Phone call.
userID		int	The ID of the user to associate the phone entry with. The `UserID` is returned in the GET Users call.

Request headers

Header	Required	Type	Description
Content-Type		string	Media type of the body sent to the API.

Request body

First call GET Phone, then modify the PhoneNumber element.

Property	Required	Type	Description
Phone		object	A valid Phone object.
PhoneTypeLink		object	A valid PhoneTypeLink object.

JSON

&#123;
  "PhoneId": 2250014,
  "PhoneNumber": "377-337-3777",
  "Type": "Business/College",
  "TypeId": 1713,
  "PhoneTypeLink": [
    &#123;
      "TypeId": 1713,
      "Type": "Business/College",
      "PhoneId": null,
      "UserId": 2716843,
      "Shared": false,
      "SharedUser": null,
      "SharedRelationShip": null,
      "InsertDate": null,
      "LastModifyDate": null,
      "LastModifyUserId": null,
      "vendor_external_id": null
    }
  ]
}

Response 200

A Response Message containing the updated phone ID.

JSON

&#123;
  "Message": "2250014"
}

Phone Properties

Name	Description	Type
PhoneID		integer
PhoneNumber		string

PhoneType Properties

Name	Description	Type
Type		string
TypeID		integer

PhoneTypeLink Properties

Name	Description	Type
UserID		integer
PhoneID		integer
Type		string
TypeID		integer