Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagexml
titlecreateMessage
<basecamp.createMessage>
	<subject>{$ctx:subject}</subject>
	<messageBoardId>{$ctx:messageBoardId}</messageBoardId>
	<status>{$ctx:status}</status>
	<projectId>{$ctx:projectId}</projectId>
	<content>{$ctx:content}</content>
	<categoryId>{$ctx:categoryId}</categoryId>
</basecamp.createMessage> 
Properties
  • subject: The subject of the message.

  • messageBoardId: The unique identifier of the message board. When click the message Board of the project, You can find the message Board Id in the URL (The URL is structured like :https://3.basecamp.com/<accountId>/buckets/<projectId>/message_boards/<messageBoardId>).

  • status: set to active to publish immediately

  • projectId: The unique identifier of the project.

  • content: The content of the message.
  • categoryId: The unique identifier of the type of the message.

...

Code Block
languagexml
titlegetMessage
<basecamp.getMessage>
	<projectId>{$ctx:projectId}</projectId>
    <messageId>{$ctx:messageId}</messageId>
</basecamp.getMessage> 
Properties
  • projectId: The identifier of the project from which the message will be retrieved.

  • messageId: The message identifier to retrieve the specified message.

...

The updateMessage operation allows changing the subject, content and category_id of the message.

Code Block
languagexml
titleupdateMessage
<basecamp.updateMessage>
    <projectId>{$ctx:projectId}</projectId>
    <messageId>{$ctx:messageId}</messageId>
    <subject>{$ctx:subject}</subject>
    <content>{$ctx:content}</content>
	<categoryId>{$ctx:categoryId}</categoryId>
</basecamp.updateMessage> 
Properties
  • projectId: The identifier of the project from which the message will be retrieved.

  • messageId: The message identifier to retrieve the specified message.

  • subject: The subject of the message.

  • content: The content of the message.

  • categoryId: The unique identifier of the type of the message.

...

Following is a sample REST request that can be handled by the getMessage updateMessage operation.

Code Block
languagexml
titleSample Request for getMessage
{
	"apiUrl":"https://3.basecampapi.com",
    "accessToken":"BAhbByIBsHsidmVyc2lvbiI6MSwidXNlcl9pZHMiOlsyMTDg13LTA0VDA3OjM2OjMxWiJ9dToJVGltZQ2HmBzAqS77kQ==--1fb2c32e4d904b7960b77d5e81db7c6666dee01c2",
    "accountId":"2669154",
	"projectId":"6224144",
	"messageId":27383420,
	"subject": "Update subject",
	"content":"Update sample message abc",
	"categoryId": "5671895"
}

...