Create company memberdeprecated

posthttps://user-api.ancon.io/public/api/v1/Outlets/{outletId}/Companies/{companyId}/Members

View .md OpenAPI

Deprecated. Check the description for the replacement and sunset date, and see how deprecation works.

Authorization

Access-Tokenheaderrequired
Tenant- or outlet-level token from the backoffice. See Get started.

Path parameters

outletIdstring (uuid)required
companyIdstring (uuid)required

Header parameters

correlationIdstring
Correlation Id for the request

Request body application/json

firstNamestring | null
lastNamestring | null
emailstring | null
phoneNumberstring | null
departmentstring | null

Responses

201Createdapplication/json

companyMemberobject | null
6 fields in companyMember
- idstring (uuid)
- fullNamestring | null
- nameobject | null
  2 fields in name
  - firstNamestring | null
  - lastNamestring | null
- emailstring | null
- phoneNumberstring | null
- departmentstring | null

400Bad Requestapplication/json

messagestring | null
errorCodestring (uuid)
additionalDataany | null

Request

curl -X POST "https://user-api.ancon.io/public/api/v1/Outlets/{outletId}/Companies/{companyId}/Members" \
  -H "Access-Token: $ANCON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "firstName": "John",
  "lastName": "Doe",
  "email": "johnjoe@ancon.io",
  "phoneNumber": "123456789",
  "department": "IT"
}'

Response

{
  "companyMember": {
    "id": "091ee127-5577-4b9f-b77a-d461979e3818",
    "fullName": "John Doe",
    "name": {
      "firstName": "John",
      "lastName": "Doe"
    },
    "email": "johnjoe@ancon.io",
    "phoneNumber": "123456789",
    "department": "IT"
  }
}

#Authorization

#Path parameters

#Header parameters

#Request body application/json

#Responses

Authorization

Path parameters

Header parameters

Request body application/json

Responses