Update org client

PATCH /orgs/clients/{clientId}

Path parameters

clientId string Required

The client's unique document ID, i.e. org.clients[]._id.

application/json

Body Required

customId string

A custom identifier for internal reference by your system (not used by missionX).
title string

The name of the client.
emailDomains array[string]

The last part (after the @) of any client emails you might want to give access to projects. E.g. missionx.ai
departments array[string]

One or more department IDs associated with this client, i.e. org.departments[]._id

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- _id string(ObjectId)
  
  The unique document ID.
- customId string
  
  A custom identifier for internal reference by your system (not used by missionX).
- title string
  
  The name of the client.
- emailDomains array[string]
  
  The last part (after the @) of any client emails you might want to give access to projects. E.g. missionx.ai
- departments array[string]
  
  One or more department IDs associated with this client, i.e. org.departments[]._id
400 application/json

Bad Request
Hide response attributes Show response attributes object
- message string
  
  An error message.
- code string
  
  An error code to handle specific error responses.
- data object
  
  Optionally, additional data to help handle the error.
  
  Hide data attributes Show data attributes object
  
  Additional properties
  
  key null
500 application/json

Internal Server Error
Hide response attributes Show response attributes object
- message string
  
  An error message.
- code string
  
  An error code to handle specific error responses.
- data object
  
  Optionally, additional data to help handle the error.
  
  Hide data attributes Show data attributes object
  
  Additional properties
  
  key null

PATCH /orgs/clients/{clientId}

curl \
 -X PATCH https://open.api.missionx.ai/v1/orgs/clients/{clientId} \
 -H "Content-Type: application/json" \
 -d '{"customId":"string","title":"string","emailDomains":["string"],"departments":["string"]}'

Request examples

{
  "customId": "string",
  "title": "string",
  "emailDomains": [
    "string"
  ],
  "departments": [
    "string"
  ]
}

Response examples (200)

{
  "_id": "string",
  "customId": "string",
  "title": "string",
  "emailDomains": [
    "string"
  ],
  "departments": [
    "string"
  ]
}

Response examples (400)

{
  "message": "string",
  "code": "string",
  "data": {
    "key": null
  }
}

Response examples (500)

{
  "message": "string",
  "code": "string",
  "data": {
    "key": null
  }
}