APIs

Create a Department Address

post
https://api.avionte.com/front-office/v1/department/address

Adds a department address to the Contacts tab of the company profile page.

Body Params
string
length ≤ 255

Street address, line 1.

string
length ≤ 255

Street address, line 2.

string
length ≤ 255

City.

string
length between 2 and 2

ISO 2-character code for the Province, State, or Region.

string
length ≤ 50

ZIP/postal code.

string
length between 2 and 2

A 2-letter ISO 3166-1 alpha-2 code representing the country (e.g., "US", not "USA"). For details, see the General Guidelines.

string
length ≤ 255

County.

string
length ≤ 50

Numerical coordinate. The value is generated based on the ZIP code, city, and state of the address.

string
length ≤ 50

School district code based on the Geo Code.

int32

The identifier for the department address.

int32

The identifier for the company branch or department.

int32

The identifier for the company.

enum

Address type for the department address.

string
length ≤ 255

The department's phone number.

boolean

An identifier of whether the department address is archived or not.

boolean

An identifier of whether the department address is the default address for the department.

string
length ≤ 50

The origin of the address of the department.

Headers
uuid

Unique request identifier (GUID) used to correlate request data with log entries and events.

integer

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

string

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Responses

401

Unauthorized

403

Access Denied

405

Unsupported method

406

Unsupported format(s) indicated by Accept header

409

Operation could not be completed due to conflict.

415

Unsupported format(s) indicated by the Content-Type header

429

Too many requests

500

An unexpected error occurred

502

Service Unavailable

504

Gateway Timeout

Updated about 2 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago