Sign in

v2

latestOpenAPI 3.0.02026-08-0793108394.2 KB
Property Inspection

Assign a user to a property inspection

post/v1/property_inspections/{property_inspection_id}/assignments

Headers

X-Encircle-Attributionstring

String used to internally identify which integrator made this request on behalf of their users.

Integrators should reuse the same 'X-Encircle-Attribution' value for all their users.

This attribution enables Encircle to provide better assistance to integrators if they encounter any issues.

If not specified, the request will not be associated with any integration services.

X-Encircle-Requeststring

Unique string used to identify each specific request.

Any retries due to connection failures should reuse the same 'X-Encircle-Request' value. This helps prevent duplicate requests from unintentionally being processed again.

If not specified, the request will be treated as unique and it will be processed normally.

Request body

idstring required

This is the email address of the person accepting/receiving the inspection assignment.

Response

The 'User' was assigned to the property inspection successfully.

idstring required
organization_idstring uuid

A RFC 4122 compliant UUID in lowercase hexadecimal.

Example response

{
  "organization_id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
}