Memosoft Docs
Updating Data

Projects

Create new project

URI: https://<im4>/project
  • Request-type: POST
  • Parameters: {data}: JSON
  • Return data:{projectId} (integer)

Creates a new project and returns project-id. Data must be provided as a JSON array.
Required fields are subject_firstname and subject_lastname.
Any other valid project key can be specified as well.

Send parameter as form-data:
Key = 'data' and Value = {json-data}
If the API client has user admin privileges, a contact person for the project can be created together with the project. In that case, send in these extra parameters in addition to the data parameter with the project JSON data:
  • Parameters:
    {contact_email} (string) (valid email, required, unique): Users email
    {contact_firstname} (string) (required) : Users first name
    {contact_lastname} (string) (required): Users last name
    {contact_phone} (string): Users phone
If contact_email is same as contact_person set in project data, the newly created contact person will be set on project.

Update project keys/properties

URI: https://<im4>/project/{projectId}
  • Request-type: POST
  • Parameters: {data}: JSON
  • Return data: HTTP 200 on success

Sets properties for given project with specified projectId. Data given as a JSON array (key => value).

See list of all valid project keys here.

Contact person can be made on project update if the API client has user admin privileges.
Read about this here

Some additional options

Proofreaders Since: 0.30
Setting proofreaders tries to match on email to update instead of adding new. To overwrite all existing proofreaders, add replaceProofreaders=true to update request.

Deliveries Since: 0.30
Setting deliveries tries to match on name to update instead of adding new.To overwrite all existing deliveries, add replaceDeliveries=true to update request.

Participants Since: 0.31
Setting participants tries to match on role to update instead of adding new. To overwrite all existing participants, add replaceParticipants=true to update request.

Preferred designs Since: 0.31
Setting designs are just adding new preferred designs for a product type. To overwrite all existing designs for a specific product type, add replaceDesigns=true to update request.

Move project to another agency

Move a project. Since: 0.26

To move a project to another agency, agency has to be in the same agency group or the same profile group as projects agency.
Read about fetching available agencies here
URI: https://<im4>/project/{projectId}/move
  • Request-type: POST
  • Parameters:
    {projectId} (part of URI): ID of the project
    {toAgency} (integer): ID of new agency
  • Return data: HTTP 200 on success

Webhooks

Program items