Skip to main content

Create Resident Pet: ResMan

POSThttps://api.propexo.com/v1/resident-pets/resman/
InterfaceMethod
Residents/Residents/PostPets
Notice

This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately.

Authentication​

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

Request​

This endpoint expects an object.

    integration_idstringrequired

    The Propexo unique identifier for the integration

    resident_idstringrequired

    The Propexo unique identifier for the resident

    age_in_yearsinteger

    The age in years of the resident pet

    Possible values: >= 0

    breedstring

    The breed of the resident pet

    colorstring

    The color of the resident pet

    namestringrequired

    The name associated with the resident pet

    notesstring

    Notes associated with the resident pet

    typestringrequired

    The type associated with the resident pet

    weight_in_poundsinteger

    The weight in pounds of the resident pet

    Possible values: >= 0

Response​

Successful response

    meta objectrequired
    job_idstringrequired
    result objectrequired
    integration_idstringrequired

    The Propexo unique identifier for the integration

    resident_idstringrequired

    The Propexo unique identifier for the resident

    age_in_yearsinteger | nullnullablerequired

    The age in years of the resident pet

    Possible values: >= 0

    breedstring | nullnullablerequired

    The breed of the resident pet

    colorstring | nullnullablerequired

    The color of the resident pet

    namestringrequired

    The name associated with the resident pet

    notesstring | nullnullablerequired

    Notes associated with the resident pet

    typestringrequired

    The type associated with the resident pet

    weight_in_poundsinteger | nullnullablerequired

    The weight in pounds of the resident pet

    Possible values: >= 0

Errors​

  • 400Bad Request
      error objectrequired
      codestringrequired
      Example: invalid_request
      messagestringrequired
      Example: invalid request
      details object
      property name*any
      Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}
POST /v1/resident-pets/resman/
curl -X POST https://api.propexo.com/v1/resident-pets/resman/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "string",
  "resident_id": "string",
  "name": "string",
  "type": "string"
}'
200 Successful response
{
  "meta": {
    "job_id": "string"
  },
  "result": {
    "integration_id": "string",
    "resident_id": "string",
    "age_in_years": 0,
    "breed": "string",
    "color": "string",
    "name": "string",
    "notes": "string",
    "type": "string",
    "weight_in_pounds": 0
  }
}