Back to API references

SOAP API method Database_contactType

Description

The ID or name of a contact type can be given as parameter. This method returns 'false' if the supplied contact type is not in the database, or the contact type collection object if the database does hold the contact type.

Parameters

Name Type Description
id * int Unique identifier (id) of the object Database. The method only applies to the database with this id.
identifier * string
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
contacttype Structure of type 'contacttype'

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt

Structure 'contacttype'

Name Type Description
id int This ID of the contact type
name string Name of the contact type
description string The description of the contact type
icon string The icon of the contact type