POST /{id}/contacts

Edits an application's contacts.

Resource Name: /applications/{id}/contacts

Permissions Required:
  • editAllApplications
Request URL Parameters:

Parameter

Type

Description
idMandatory

String

The application's revision ID.
addContacts

Array of ContactRequest (see ContactRequest )

List of contacts that the user would like to add to the application revision.
removeContacts

Array of ContactRequest (see ContactRequest )

List of contacts that the user would like to remove from application revision.

Return:

Parameter

Type

Description
applicationId

Integer

Edited application's ID.
contacts

Array of ContactRequest (see ContactRequest )

List of all application contacts.
Error Codes:
  • 404 (Not found) - Application wasn't found.
  • 403 (Forbidden) - User doesn't have permission to edit the application.
  • 403 (Forbidden) - User doesn't have permission to edit the application's general information.
  • 400 (Bad request) - Contacts do not exist.
  • 400 (Bad request) - Invalid role.

Request example: 

POST <ip:port>/BusinessFlow/rest/v1/application/15/contacts
{
  "addContacts": [
    {
      "email": "[email protected]",
      "role": "General Contact" 
    }
  ],
  "removeContacts": [
    {
      "email": "[email protected]",
      "role": "Business Owner"
    }
  ]
}

Return Example:

{  "applicationId": 15,  "contacts": [    {      "email": "[email protected]",       "role": "General Contact"    }  ]}

 

â See also: