Skip to main content
POST
Create a counterpart contact

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-finops-version
string<date>
required
x-organization-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

counterpart_id
string<uuid>
required

Body

application/json

The contact person for an organization.

address
object
required

The address of a contact person.

first_name
string
required

The first name of a contact person.

Maximum string length: 100
Example:

"Mary"

last_name
string
required

The last name of a contact person.

Maximum string length: 100
Example:

"O'Brien"

email
string<email>

The email address of a contact person.

Example:

"contact@example.org"

phone
string

The phone number of a contact person

Maximum string length: 100
Example:

"5551235476"

title
string

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

Maximum string length: 100
Example:

"Ms."

Response

Successful Response

The contact person for an organization.

id
string<uuid>
required
address
object
required

The address of a contact person.

counterpart_id
string<uuid>
required
first_name
string
required

The first name of a contact person.

Maximum string length: 100
Example:

"Mary"

is_default
boolean
required
last_name
string
required

The last name of a contact person.

Maximum string length: 100
Example:

"O'Brien"

email
string<email>

The email address of a contact person.

Example:

"contact@example.org"

phone
string

The phone number of a contact person

Maximum string length: 100
Example:

"5551235476"

title
string

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

Maximum string length: 100
Example:

"Ms."