Entities Create API

Route

POST

Purpose


Parameters


token string 100 required
Authentication token for either an application or session.
view string 100
The view attribute controls what data is returned about the requested record.
Possible values
  • planox_company_read_profile
  • planox_company_read_preferences
  • planoadmin_company_read
  • entity_view

integration_id integer 100 required
ID that identifies what integration the entity is associated to.
entity_slug string 100 required
Unique identifying slug of entity.
email string 200 required
Unique identifying email of entity.
name string 300 required
Indicates the name of the entity.
address string 400 required
Indicates the name of the entity.
  • address.street string
    Street of the address
  • address.street2 string
    Street input 2 of the address
  • address.city string
    City
  • address.state string
    State
  • address.country string
    Country
  • address.postal_code string
    Postal Code
  • address.service_area string

operational_transaction_emails array 500
Comma separated list of emails.
order_completion_emails array 500
Comma separated list of emails.
active boolean 600 required
Indicates if the entity is active or not.

Request Body Example: application/json

Responses

action-successful 200

This status indicates that the request was successful. If the request returns data, it can be found in the data key.

invalid-token 401

This status is returned when the authentication token passed is invalid.

session-expired 401

This status is returned a session is older than seven days or hasn't been used in 72 hours. The user will need to reauthenticate. We allow our users to save a remember_me preference which will make there sessions last indefinitely.

client-required 401

This status is returned when the user makeing the request doesn't have a client, employee or liaison record. This means that they don't have any roles or permissions. Because we only allow our clients to register as a client, the user should be redirected to the PlanoAuth clients registration page where they can use the `/api/v1/users/client_register` API to register as a client. Eventhough the request will not be successful, this status will still return a `session` object because a session token is needed to register as a user.

missing-param 400

This status is returned when a required param was not passed with the request.

invalid-param 400

This status is returned when a param was invalid when passed. For example, passing an id that doesn't exist or passing an invalid email address.

application-crash 500

This status is returned when there is an internal server error. Please try again later.

mandrill-email-failed 500

This status is returned when there was an issue using Mandrill to send an email. Any time this response is returned, there will be a notification in the production notifications tab so the dev team will be away of the failure. These errors will most likely correlate with a data issue and will need to be invesigated.

invalid-content-type 400

This status is returned if the request was made with the incorrect content-type so the request params could not be read. For more infromation on content-type, please refer to https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type.

route-non-existent 500

Response returned when HTTP route does not exist.

Uncommon Responses

The responses below are not very common.

no-params-decoded Uncommon

This status is returned the request body was decoded, but no params where found.

invalid-encoded-params Uncommon

This status is returned when the request body could not be decoded properly. This generally means that you are requesting a sensative_params API and your request body was not base64 encoded.

route-not-found Uncommon

This status is returned when the route record being requested hasn't been deployed yet.

identify-request-error Uncommon

This status is returned when there is an internal server error before the route could be identified. Please try again later.

service-not-found Uncommon

This status is returned when the route's API service record being requested hasn't been deployed yet.