Contacts

Update a contact

Updates a contact's details and status.

put/contacts/{contact_id}

Request

  • Base URL: https://api.streamtime.net/v2
  • URL: https://api.streamtime.net/v2/contacts/{contact_id}
  • Auth: HTTP bearer

Path parameters

contact_idinteger required

Contact ID

Request body

idinteger

Contact ID

firstNamestring

First name

lastNamestring nullable

Last name

emailstring email nullable

Email address

phoneNumberstring nullable

Phone number

positionstring nullable

Position / Job title

notesstring nullable

Notes

activeboolean

Is contact active

companyIdinteger

Company ID this contact belongs to

Example request

{
  "id": 501,
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@example.com",
  "phoneNumber": "+64 21 123 4567",
  "position": "Project Manager",
  "notes": "Prefers email contact",
  "active": true,
  "companyId": 2001
}

Response

Contact updated successfully.

idinteger

Contact ID

firstNamestring

First name

lastNamestring nullable

Last name

emailstring email nullable

Email address

phoneNumberstring nullable

Phone number

positionstring nullable

Position / Job title

notesstring nullable

Notes

activeboolean

Is contact active

companyIdinteger

Company ID this contact belongs to

Example response

{
  "id": 501,
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@example.com",
  "phoneNumber": "+64 21 123 4567",
  "position": "Project Manager",
  "notes": "Prefers email contact",
  "active": true,
  "companyId": 2001
}

Changes

No recorded changes to this operation across all 1 revision of this API.