Create a counterpart contact (v2023-09-01)

Path parameters

counterpart_idstringRequired

Headers

Auth

AuthorizationstringRequired

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

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.

addressobjectRequired

The address of a contact person.

first_namestringRequired

The first name of a contact person.

last_namestringRequired

The last name of a contact person.

emailstringOptional

The email address of a contact person.

phonestringOptional

The phone number of a contact person

titlestringOptional

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

Response

Successful Response

idstring

addressobject

The address of a contact person.

counterpart_idstring

first_namestring

The first name of a contact person.

is_defaultboolean

last_namestring

The last name of a contact person.

emailstringOptional

The email address of a contact person.

phonestringOptional

The phone number of a contact person

titlestringOptional

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

Errors

1 curl -X POST https://api.sandbox.monite.com/v1/counterparts/counterpart_id/contacts \ 2 -H "x-monite-version: 2023-09-01" \ 3 -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \ 4 -H "Authorization: Bearer <token>" \ 5 -H "Content-Type: application/json" \ 6 -d '{ 7 "address": { 8 "city": "Berlin", 9 "country": "AF", 10 "line1": "Flughafenstrasse 52", 11 "postal_code": "10115" 12 }, 13 "first_name": "Mary", 14 "last_name": "O\'Brien" 15 }'

1 { 2 "id": "id", 3 "address": { 4 "city": "Berlin", 5 "country": "AF", 6 "line1": "Flughafenstrasse 52", 7 "postal_code": "10115", 8 "line2": "line2", 9 "state": "state" 10 }, 11 "counterpart_id": "counterpart_id", 12 "first_name": "Mary", 13 "is_default": true, 14 "last_name": "O'Brien", 15 "email": "contact@example.org", 16 "phone": "5551235476", 17 "title": "Ms." 18 }

1	curl -X POST https://api.sandbox.monite.com/v1/counterparts/counterpart_id/contacts \
2	-H "x-monite-version: 2023-09-01" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>" \
5	-H "Content-Type: application/json" \
6	-d '{
7	"address": {
8	"city": "Berlin",
9	"country": "AF",
10	"line1": "Flughafenstrasse 52",
11	"postal_code": "10115"
12	},
13	"first_name": "Mary",
14	"last_name": "O\'Brien"
15	}'

1	{
2	"id": "id",
3	"address": {
4	"city": "Berlin",
5	"country": "AF",
6	"line1": "Flughafenstrasse 52",
7	"postal_code": "10115",
8	"line2": "line2",
9	"state": "state"
10	},
11	"counterpart_id": "counterpart_id",
12	"first_name": "Mary",
13	"is_default": true,
14	"last_name": "O'Brien",
15	"email": "contact@example.org",
16	"phone": "5551235476",
17	"title": "Ms."
18	}