Counterpart contacts

Create a counterpart contact

Counterparts of the organization type can have additional contacts defined. Contacts are useful if you need to use different contact information for the same counterpart in different invoices.

The first contact you add to a counterpart becomes its default contact. The default contact, if it exists, is automatically selected when you create invoices and quotes for this counterpart, but the contact information can also be changed later on the document level. To select a different contact as the default one, use POST /counterparts/{counterpart_id}/contacts/{contact_id}/make_default.

post/counterparts/{counterpart_id}/contacts

Request

  • Base URL: https://api.sandbox.monite.com/v1
  • URL: https://api.sandbox.monite.com/v1/counterparts/{counterpart_id}/contacts
  • Auth: HTTP bearer

Path parameters

counterpart_idstring required

ID of a counterpart to add a contact for. This counterpart must be an organization, not an individual.

Headers

x-monite-versionstring required
x-monite-entity-idstring required

The ID of the entity that owns the requested resource.

Request body

emailstring email

The email address of a contact person.

first_namestring required

The first name of a contact person.

last_namestring required

The last name of a contact person.

phonestring

The phone number of a contact person

titlestring

The title or honorific of a contact person. Examples: Mr., Ms., Dr., Prof.

Response

Successful Response

idstring uuid required

A unique ID assigned to this counterpart contact.

counterpart_idstring uuid required

ID of the counterpart to which this contact belongs.

emailstring email

The email address of a contact person.

first_namestring required

The first name of a contact person.

is_defaultboolean required

Indicates whether this contact is the default one. The default contact is used to fill in the counterpart's contact details when you create invoices and quotes for this counterpart.

To select another contact as the default one, use POST /counterparts/{counterpart_id}/contacts/{contact_id}/make_default.

last_namestring required

The last name of a contact person.

phonestring

The phone number of a contact person

titlestring

The title or honorific of a contact person. Examples: Mr., Ms., Dr., Prof.

Changes

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