COconnexcs
Phonebook

Update

Changed on

Update an existing Phonebook record by ID.

put/api/cp/phonebook/{id}

Request

  • Base URL
    https://app.connexcs.com
  • Auth
    • OAuth 2
      Authorization code: https://auth.connexcs.com/authorize
      Token URL: https://auth.connexcs.com/token
    • or HTTP bearer

Path parameters

idinteger required

Id identifier

Request body

idinteger

Id

company_idinteger

Company Id

usernamestring

Username

organizationstring

Organization

name_givenstring

Name Given

name_familystring

Name Family

typestring

Type

categorystring

Category

Example request

{
  "id": 12345,
  "company_id": 1,
  "username": "john_doe",
  "organization": "example_organization",
  "name_given": "example_name_given",
  "name_family": "example_name_family",
  "type": "example_type",
  "category": "example_category"
}

Response

Operation completed successfully

statusstring

Operation status

Example response

{
  "status": "OK"
}

Changes

  • fa097c4785b8Revision changes
    • info

      the endpoint scheme security oAuth2 was added to the API

    • info

      the endpoint scheme security opaqueToken was added to the API

    • info

      the endpoint scheme security basicAuth was removed from the API